Cisco-IOS-XR-ipv4-bgp-cfg API API Reference

API generated from Cisco-IOS-XR-ipv4-bgp-cfg@2018-01-18.yang

API Endpoint

http://{Controller-IP}:{Controller-Port}/restconf

Schemes: http

Version: 1.0.0

Paths

BGP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/

Update operation of resource: bgp

bgp_schema

bgpbody object

Request Content-Types: application/json

Request Example

{
  "instance": [
    {
      "instance-as": [
        {
          "four-byte-as": [
            {
              "bgp-running": [ null ],
              "vrfs": {
                "vrf": [
                  {
                    "vrf-global": {
                      "route-distinguisher": {
                        "as-index": "string",
                        "address-index": "string",
                        "as-xx": "string",
                        "as": "string",
                        "address": "string",
                        "type": "string"
                      },
                      "exists": [ null ],
                      "vrf-global-afs": {
                        "vrf-global-af": [
                          {
                            "ibgp": {
                              "order-by-igp-metric": "boolean",
                              "paths-value": "integer",
                              "selective": "boolean",
                              "unequal-cost": "boolean"
                            },
                            "mvpn": {
                              "single-forwarder-selection": "string"
                            },
                            "rt-download": [ null ],
                            "af-name": "string",
                            "eibgp": {
                              "order-by-igp-metric": "boolean",
                              "paths-value": "integer",
                              "selective": "boolean",
                              "unequal-cost": "boolean"
                            },
                            "ebgp": {
                              "order-by-igp-metric": "boolean",
                              "paths-value": "integer",
                              "selective": "boolean",
                              "unequal-cost": "boolean"
                            },
                            "allow-vpn-default-originate": "boolean",
                            "subscriber-routes": {
                              "default-metric": "string",
                              "route-policy-name": "string",
                              "not-used": "integer"
                            }
                          }
                        ]
                      },
                      "local-preference": "integer"
                    },
                    "vrf-name": "string",
                    "vrf-neighbors": {
                      "vrf-neighbor-prefix-length": [
                        {
                          "neighbor-address": "string",
                          "prefix-length": "integer"
                        }
                      ],
                      "vrf-neighbor": [
                        {
                          "neighbor-address": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "as": "string",
              "default-vrf": {
                "global": {
                  "mvpn": [ null ],
                  "rpki-origin-as-validation-disable": [ null ],
                  "rpki-static-routes": {
                    "rpki-static-route": [
                      {
                        "addrress": "string",
                        "as": "integer",
                        "minimum": "integer",
                        "maximum": "integer"
                      }
                    ]
                  },
                  "update-error-handling-extended-ibgp": [ null ],
                  "install-diversion": [ null ],
                  "attribute-filter-groups": {
                    "attribute-filter-group": [
                      {
                        "enable": [ null ],
                        "attribute-filter-group-name": "string",
                        "attribute-filters": {
                          "attribute-filter": [
                            {
                              "attribute-start": "string",
                              "attribute-end": "string",
                              "filter-action": "string"
                            }
                          ]
                        }
                      }
                    ]
                  },
                  "update-limit-process": "integer",
                  "rpki-origin-as-validation-time": "integer",
                  "nsr": "boolean",
                  "local-preference": "integer"
                }
              }
            }
          ]
        }
      ]
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BGP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/

Create operation of resource: bgp

bgp_schema

bgpbody object

Request Content-Types: application/json

Request Example

{
  "instance": [
    {
      "instance-as": [
        {
          "four-byte-as": [
            {
              "bgp-running": [ null ],
              "vrfs": {
                "vrf": [
                  {
                    "vrf-global": {
                      "route-distinguisher": {
                        "as-index": "string",
                        "address-index": "string",
                        "as-xx": "string",
                        "as": "string",
                        "address": "string",
                        "type": "string"
                      },
                      "exists": [ null ],
                      "vrf-global-afs": {
                        "vrf-global-af": [
                          {
                            "ibgp": {
                              "order-by-igp-metric": "boolean",
                              "paths-value": "integer",
                              "selective": "boolean",
                              "unequal-cost": "boolean"
                            },
                            "mvpn": {
                              "single-forwarder-selection": "string"
                            },
                            "rt-download": [ null ],
                            "af-name": "string",
                            "eibgp": {
                              "order-by-igp-metric": "boolean",
                              "paths-value": "integer",
                              "selective": "boolean",
                              "unequal-cost": "boolean"
                            },
                            "ebgp": {
                              "order-by-igp-metric": "boolean",
                              "paths-value": "integer",
                              "selective": "boolean",
                              "unequal-cost": "boolean"
                            },
                            "allow-vpn-default-originate": "boolean",
                            "subscriber-routes": {
                              "default-metric": "string",
                              "route-policy-name": "string",
                              "not-used": "integer"
                            }
                          }
                        ]
                      },
                      "local-preference": "integer"
                    },
                    "vrf-name": "string",
                    "vrf-neighbors": {
                      "vrf-neighbor-prefix-length": [
                        {
                          "neighbor-address": "string",
                          "prefix-length": "integer"
                        }
                      ],
                      "vrf-neighbor": [
                        {
                          "neighbor-address": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "as": "string",
              "default-vrf": {
                "global": {
                  "mvpn": [ null ],
                  "rpki-origin-as-validation-disable": [ null ],
                  "rpki-static-routes": {
                    "rpki-static-route": [
                      {
                        "addrress": "string",
                        "as": "integer",
                        "minimum": "integer",
                        "maximum": "integer"
                      }
                    ]
                  },
                  "update-error-handling-extended-ibgp": [ null ],
                  "install-diversion": [ null ],
                  "attribute-filter-groups": {
                    "attribute-filter-group": [
                      {
                        "enable": [ null ],
                        "attribute-filter-group-name": "string",
                        "attribute-filters": {
                          "attribute-filter": [
                            {
                              "attribute-start": "string",
                              "attribute-end": "string",
                              "filter-action": "string"
                            }
                          ]
                        }
                      }
                    ]
                  },
                  "update-limit-process": "integer",
                  "rpki-origin-as-validation-time": "integer",
                  "nsr": "boolean",
                  "local-preference": "integer"
                }
              }
            }
          ]
        }
      ]
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BGP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/

Delete operation of resource: bgp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BGP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/

Retrieve operation of resource: bgp

200 OK

bgp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "instance": [
    {
      "instance-as": [
        {
          "four-byte-as": [
            {
              "bgp-running": [ null ],
              "vrfs": {
                "vrf": [
                  {
                    "vrf-global": {
                      "route-distinguisher": {
                        "as-index": "string",
                        "address-index": "string",
                        "as-xx": "string",
                        "as": "string",
                        "address": "string",
                        "type": "string"
                      },
                      "exists": [ null ],
                      "vrf-global-afs": {
                        "vrf-global-af": [
                          {
                            "ibgp": {
                              "order-by-igp-metric": "boolean",
                              "paths-value": "integer",
                              "selective": "boolean",
                              "unequal-cost": "boolean"
                            },
                            "mvpn": {
                              "single-forwarder-selection": "string"
                            },
                            "rt-download": [ null ],
                            "af-name": "string",
                            "eibgp": {
                              "order-by-igp-metric": "boolean",
                              "paths-value": "integer",
                              "selective": "boolean",
                              "unequal-cost": "boolean"
                            },
                            "ebgp": {
                              "order-by-igp-metric": "boolean",
                              "paths-value": "integer",
                              "selective": "boolean",
                              "unequal-cost": "boolean"
                            },
                            "allow-vpn-default-originate": "boolean",
                            "subscriber-routes": {
                              "default-metric": "string",
                              "route-policy-name": "string",
                              "not-used": "integer"
                            }
                          }
                        ]
                      },
                      "local-preference": "integer"
                    },
                    "vrf-name": "string",
                    "vrf-neighbors": {
                      "vrf-neighbor-prefix-length": [
                        {
                          "neighbor-address": "string",
                          "prefix-length": "integer"
                        }
                      ],
                      "vrf-neighbor": [
                        {
                          "neighbor-address": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "as": "string",
              "default-vrf": {
                "global": {
                  "mvpn": [ null ],
                  "rpki-origin-as-validation-disable": [ null ],
                  "rpki-static-routes": {
                    "rpki-static-route": [
                      {
                        "addrress": "string",
                        "as": "integer",
                        "minimum": "integer",
                        "maximum": "integer"
                      }
                    ]
                  },
                  "update-error-handling-extended-ibgp": [ null ],
                  "install-diversion": [ null ],
                  "attribute-filter-groups": {
                    "attribute-filter-group": [
                      {
                        "enable": [ null ],
                        "attribute-filter-group-name": "string",
                        "attribute-filters": {
                          "attribute-filter": [
                            {
                              "attribute-start": "string",
                              "attribute-end": "string",
                              "filter-action": "string"
                            }
                          ]
                        }
                      }
                    ]
                  },
                  "update-limit-process": "integer",
                  "rpki-origin-as-validation-time": "integer",
                  "nsr": "boolean",
                  "local-preference": "integer"
                }
              }
            }
          ]
        }
      ]
    }
  ]
}

INSTANCE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/

Update operation of resource: instance

instance_schema

instancebody object

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "instance-as": [
    {
      "four-byte-as": [
        {
          "bgp-running": [ null ],
          "vrfs": {
            "vrf": [
              {
                "vrf-global": {
                  "route-distinguisher": {
                    "as-index": "string",
                    "address-index": "string",
                    "as-xx": "string",
                    "as": "string",
                    "address": "string",
                    "type": "string"
                  },
                  "exists": [ null ],
                  "vrf-global-afs": {
                    "vrf-global-af": [
                      {
                        "ibgp": {
                          "order-by-igp-metric": "boolean",
                          "paths-value": "integer",
                          "selective": "boolean",
                          "unequal-cost": "boolean"
                        },
                        "mvpn": {
                          "single-forwarder-selection": "string"
                        },
                        "rt-download": [ null ],
                        "af-name": "string",
                        "eibgp": {
                          "order-by-igp-metric": "boolean",
                          "paths-value": "integer",
                          "selective": "boolean",
                          "unequal-cost": "boolean"
                        },
                        "ebgp": {
                          "order-by-igp-metric": "boolean",
                          "paths-value": "integer",
                          "selective": "boolean",
                          "unequal-cost": "boolean"
                        },
                        "allow-vpn-default-originate": "boolean",
                        "subscriber-routes": {
                          "default-metric": "string",
                          "route-policy-name": "string",
                          "not-used": "integer"
                        }
                      }
                    ]
                  },
                  "local-preference": "integer"
                },
                "vrf-name": "string",
                "vrf-neighbors": {
                  "vrf-neighbor-prefix-length": [
                    {
                      "neighbor-address": "string",
                      "prefix-length": "integer"
                    }
                  ],
                  "vrf-neighbor": [
                    {
                      "neighbor-address": "string"
                    }
                  ]
                }
              }
            ]
          },
          "as": "string",
          "default-vrf": {
            "global": {
              "mvpn": [ null ],
              "rpki-origin-as-validation-disable": [ null ],
              "rpki-static-routes": {
                "rpki-static-route": [
                  {
                    "addrress": "string",
                    "as": "integer",
                    "minimum": "integer",
                    "maximum": "integer"
                  }
                ]
              },
              "update-error-handling-extended-ibgp": [ null ],
              "install-diversion": [ null ],
              "attribute-filter-groups": {
                "attribute-filter-group": [
                  {
                    "enable": [ null ],
                    "attribute-filter-group-name": "string",
                    "attribute-filters": {
                      "attribute-filter": [
                        {
                          "attribute-start": "string",
                          "attribute-end": "string",
                          "filter-action": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "update-limit-process": "integer",
              "rpki-origin-as-validation-time": "integer",
              "nsr": "boolean",
              "read-only": [ null ],
              "graceful-restart-stalepath-time": "integer",
              "local-preference": "integer"
            }
          }
        }
      ]
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/

Create operation of resource: instance

instance_schema

instancebody object

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "instance-as": [
    {
      "four-byte-as": [
        {
          "bgp-running": [ null ],
          "vrfs": {
            "vrf": [
              {
                "vrf-global": {
                  "route-distinguisher": {
                    "as-index": "string",
                    "address-index": "string",
                    "as-xx": "string",
                    "as": "string",
                    "address": "string",
                    "type": "string"
                  },
                  "exists": [ null ],
                  "vrf-global-afs": {
                    "vrf-global-af": [
                      {
                        "ibgp": {
                          "order-by-igp-metric": "boolean",
                          "paths-value": "integer",
                          "selective": "boolean",
                          "unequal-cost": "boolean"
                        },
                        "mvpn": {
                          "single-forwarder-selection": "string"
                        },
                        "rt-download": [ null ],
                        "af-name": "string",
                        "eibgp": {
                          "order-by-igp-metric": "boolean",
                          "paths-value": "integer",
                          "selective": "boolean",
                          "unequal-cost": "boolean"
                        },
                        "ebgp": {
                          "order-by-igp-metric": "boolean",
                          "paths-value": "integer",
                          "selective": "boolean",
                          "unequal-cost": "boolean"
                        },
                        "allow-vpn-default-originate": "boolean",
                        "subscriber-routes": {
                          "default-metric": "string",
                          "route-policy-name": "string",
                          "not-used": "integer"
                        }
                      }
                    ]
                  },
                  "local-preference": "integer"
                },
                "vrf-name": "string",
                "vrf-neighbors": {
                  "vrf-neighbor-prefix-length": [
                    {
                      "neighbor-address": "string",
                      "prefix-length": "integer"
                    }
                  ],
                  "vrf-neighbor": [
                    {
                      "neighbor-address": "string"
                    }
                  ]
                }
              }
            ]
          },
          "as": "string",
          "default-vrf": {
            "global": {
              "mvpn": [ null ],
              "rpki-origin-as-validation-disable": [ null ],
              "rpki-static-routes": {
                "rpki-static-route": [
                  {
                    "addrress": "string",
                    "as": "integer",
                    "minimum": "integer",
                    "maximum": "integer"
                  }
                ]
              },
              "update-error-handling-extended-ibgp": [ null ],
              "install-diversion": [ null ],
              "attribute-filter-groups": {
                "attribute-filter-group": [
                  {
                    "enable": [ null ],
                    "attribute-filter-group-name": "string",
                    "attribute-filters": {
                      "attribute-filter": [
                        {
                          "attribute-start": "string",
                          "attribute-end": "string",
                          "filter-action": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "update-limit-process": "integer",
              "rpki-origin-as-validation-time": "integer",
              "nsr": "boolean",
              "read-only": [ null ],
              "graceful-restart-stalepath-time": "integer",
              "local-preference": "integer"
            }
          }
        }
      ]
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/

Delete operation of resource: instance

instance-name

in path

string

ID of instance-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/

Retrieve operation of resource: instance

instance-name

in path

string

ID of instance-name

200 OK

instance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "instance-as": [
    {
      "four-byte-as": [
        {
          "bgp-running": [ null ],
          "vrfs": {
            "vrf": [
              {
                "vrf-global": {
                  "route-distinguisher": {
                    "as-index": "string",
                    "address-index": "string",
                    "as-xx": "string",
                    "as": "string",
                    "address": "string",
                    "type": "string"
                  },
                  "exists": [ null ],
                  "vrf-global-afs": {
                    "vrf-global-af": [
                      {
                        "ibgp": {
                          "order-by-igp-metric": "boolean",
                          "paths-value": "integer",
                          "selective": "boolean",
                          "unequal-cost": "boolean"
                        },
                        "mvpn": {
                          "single-forwarder-selection": "string"
                        },
                        "rt-download": [ null ],
                        "af-name": "string",
                        "eibgp": {
                          "order-by-igp-metric": "boolean",
                          "paths-value": "integer",
                          "selective": "boolean",
                          "unequal-cost": "boolean"
                        },
                        "ebgp": {
                          "order-by-igp-metric": "boolean",
                          "paths-value": "integer",
                          "selective": "boolean",
                          "unequal-cost": "boolean"
                        },
                        "allow-vpn-default-originate": "boolean",
                        "subscriber-routes": {
                          "default-metric": "string",
                          "route-policy-name": "string",
                          "not-used": "integer"
                        }
                      }
                    ]
                  },
                  "local-preference": "integer"
                },
                "vrf-name": "string",
                "vrf-neighbors": {
                  "vrf-neighbor-prefix-length": [
                    {
                      "neighbor-address": "string",
                      "prefix-length": "integer"
                    }
                  ],
                  "vrf-neighbor": [
                    {
                      "neighbor-address": "string"
                    }
                  ]
                }
              }
            ]
          },
          "as": "string",
          "default-vrf": {
            "global": {
              "mvpn": [ null ],
              "rpki-origin-as-validation-disable": [ null ],
              "rpki-static-routes": {
                "rpki-static-route": [
                  {
                    "addrress": "string",
                    "as": "integer",
                    "minimum": "integer",
                    "maximum": "integer"
                  }
                ]
              },
              "update-error-handling-extended-ibgp": [ null ],
              "install-diversion": [ null ],
              "attribute-filter-groups": {
                "attribute-filter-group": [
                  {
                    "enable": [ null ],
                    "attribute-filter-group-name": "string",
                    "attribute-filters": {
                      "attribute-filter": [
                        {
                          "attribute-start": "string",
                          "attribute-end": "string",
                          "filter-action": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "update-limit-process": "integer",
              "rpki-origin-as-validation-time": "integer",
              "nsr": "boolean",
              "read-only": [ null ],
              "graceful-restart-stalepath-time": "integer",
              "local-preference": "integer"
            }
          }
        }
      ]
    }
  ]
}

INSTANCE-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/

Update operation of resource: instance-as

instance-as_schema

instance-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

Request Content-Types: application/json

Request Example

{
  "four-byte-as": [
    {
      "bgp-running": [ null ],
      "vrfs": {
        "vrf": [
          {
            "vrf-global": {
              "route-distinguisher": {
                "as-index": "string",
                "address-index": "string",
                "as-xx": "string",
                "as": "string",
                "address": "string",
                "type": "string"
              },
              "exists": [ null ],
              "vrf-global-afs": {
                "vrf-global-af": [
                  {
                    "ibgp": {
                      "order-by-igp-metric": "boolean",
                      "paths-value": "integer",
                      "selective": "boolean",
                      "unequal-cost": "boolean"
                    },
                    "mvpn": {
                      "single-forwarder-selection": "string"
                    },
                    "rt-download": [ null ],
                    "af-name": "string",
                    "eibgp": {
                      "order-by-igp-metric": "boolean",
                      "paths-value": "integer",
                      "selective": "boolean",
                      "unequal-cost": "boolean"
                    },
                    "ebgp": {
                      "order-by-igp-metric": "boolean",
                      "paths-value": "integer",
                      "selective": "boolean",
                      "unequal-cost": "boolean"
                    },
                    "allow-vpn-default-originate": "boolean",
                    "subscriber-routes": {
                      "default-metric": "string",
                      "route-policy-name": "string",
                      "not-used": "integer"
                    }
                  }
                ]
              },
              "local-preference": "integer"
            },
            "vrf-name": "string",
            "vrf-neighbors": {
              "vrf-neighbor-prefix-length": [
                {
                  "neighbor-address": "string",
                  "prefix-length": "integer"
                }
              ],
              "vrf-neighbor": [
                {
                  "neighbor-address": "string"
                }
              ]
            }
          }
        ]
      },
      "as": "string",
      "default-vrf": {
        "global": {
          "mvpn": [ null ],
          "rpki-origin-as-validation-disable": [ null ],
          "rpki-static-routes": {
            "rpki-static-route": [
              {
                "addrress": "string",
                "as": "integer",
                "minimum": "integer",
                "maximum": "integer"
              }
            ]
          },
          "update-error-handling-extended-ibgp": [ null ],
          "install-diversion": [ null ],
          "attribute-filter-groups": {
            "attribute-filter-group": [
              {
                "enable": [ null ],
                "attribute-filter-group-name": "string",
                "attribute-filters": {
                  "attribute-filter": [
                    {
                      "attribute-start": "string",
                      "attribute-end": "string",
                      "filter-action": "string"
                    }
                  ]
                }
              }
            ]
          },
          "update-limit-process": "integer",
          "rpki-origin-as-validation-time": "integer",
          "nsr": "boolean",
          "read-only": [ null ],
          "graceful-restart-stalepath-time": "integer",
          "graceful-reset": [ null ],
          "update-out-logging": [ null ],
          "local-preference": "integer"
        }
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/

Create operation of resource: instance-as

instance-as_schema

instance-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

Request Content-Types: application/json

Request Example

{
  "four-byte-as": [
    {
      "bgp-running": [ null ],
      "vrfs": {
        "vrf": [
          {
            "vrf-global": {
              "route-distinguisher": {
                "as-index": "string",
                "address-index": "string",
                "as-xx": "string",
                "as": "string",
                "address": "string",
                "type": "string"
              },
              "exists": [ null ],
              "vrf-global-afs": {
                "vrf-global-af": [
                  {
                    "ibgp": {
                      "order-by-igp-metric": "boolean",
                      "paths-value": "integer",
                      "selective": "boolean",
                      "unequal-cost": "boolean"
                    },
                    "mvpn": {
                      "single-forwarder-selection": "string"
                    },
                    "rt-download": [ null ],
                    "af-name": "string",
                    "eibgp": {
                      "order-by-igp-metric": "boolean",
                      "paths-value": "integer",
                      "selective": "boolean",
                      "unequal-cost": "boolean"
                    },
                    "ebgp": {
                      "order-by-igp-metric": "boolean",
                      "paths-value": "integer",
                      "selective": "boolean",
                      "unequal-cost": "boolean"
                    },
                    "allow-vpn-default-originate": "boolean",
                    "subscriber-routes": {
                      "default-metric": "string",
                      "route-policy-name": "string",
                      "not-used": "integer"
                    }
                  }
                ]
              },
              "local-preference": "integer"
            },
            "vrf-name": "string",
            "vrf-neighbors": {
              "vrf-neighbor-prefix-length": [
                {
                  "neighbor-address": "string",
                  "prefix-length": "integer"
                }
              ],
              "vrf-neighbor": [
                {
                  "neighbor-address": "string"
                }
              ]
            }
          }
        ]
      },
      "as": "string",
      "default-vrf": {
        "global": {
          "mvpn": [ null ],
          "rpki-origin-as-validation-disable": [ null ],
          "rpki-static-routes": {
            "rpki-static-route": [
              {
                "addrress": "string",
                "as": "integer",
                "minimum": "integer",
                "maximum": "integer"
              }
            ]
          },
          "update-error-handling-extended-ibgp": [ null ],
          "install-diversion": [ null ],
          "attribute-filter-groups": {
            "attribute-filter-group": [
              {
                "enable": [ null ],
                "attribute-filter-group-name": "string",
                "attribute-filters": {
                  "attribute-filter": [
                    {
                      "attribute-start": "string",
                      "attribute-end": "string",
                      "filter-action": "string"
                    }
                  ]
                }
              }
            ]
          },
          "update-limit-process": "integer",
          "rpki-origin-as-validation-time": "integer",
          "nsr": "boolean",
          "read-only": [ null ],
          "graceful-restart-stalepath-time": "integer",
          "graceful-reset": [ null ],
          "update-out-logging": [ null ],
          "local-preference": "integer"
        }
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/

Delete operation of resource: instance-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/

Retrieve operation of resource: instance-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

200 OK

instance-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "four-byte-as": [
    {
      "bgp-running": [ null ],
      "vrfs": {
        "vrf": [
          {
            "vrf-global": {
              "route-distinguisher": {
                "as-index": "string",
                "address-index": "string",
                "as-xx": "string",
                "as": "string",
                "address": "string",
                "type": "string"
              },
              "exists": [ null ],
              "vrf-global-afs": {
                "vrf-global-af": [
                  {
                    "ibgp": {
                      "order-by-igp-metric": "boolean",
                      "paths-value": "integer",
                      "selective": "boolean",
                      "unequal-cost": "boolean"
                    },
                    "mvpn": {
                      "single-forwarder-selection": "string"
                    },
                    "rt-download": [ null ],
                    "af-name": "string",
                    "eibgp": {
                      "order-by-igp-metric": "boolean",
                      "paths-value": "integer",
                      "selective": "boolean",
                      "unequal-cost": "boolean"
                    },
                    "ebgp": {
                      "order-by-igp-metric": "boolean",
                      "paths-value": "integer",
                      "selective": "boolean",
                      "unequal-cost": "boolean"
                    },
                    "allow-vpn-default-originate": "boolean",
                    "subscriber-routes": {
                      "default-metric": "string",
                      "route-policy-name": "string",
                      "not-used": "integer"
                    }
                  }
                ]
              },
              "local-preference": "integer"
            },
            "vrf-name": "string",
            "vrf-neighbors": {
              "vrf-neighbor-prefix-length": [
                {
                  "neighbor-address": "string",
                  "prefix-length": "integer"
                }
              ],
              "vrf-neighbor": [
                {
                  "neighbor-address": "string"
                }
              ]
            }
          }
        ]
      },
      "as": "string",
      "default-vrf": {
        "global": {
          "mvpn": [ null ],
          "rpki-origin-as-validation-disable": [ null ],
          "rpki-static-routes": {
            "rpki-static-route": [
              {
                "addrress": "string",
                "as": "integer",
                "minimum": "integer",
                "maximum": "integer"
              }
            ]
          },
          "update-error-handling-extended-ibgp": [ null ],
          "install-diversion": [ null ],
          "attribute-filter-groups": {
            "attribute-filter-group": [
              {
                "enable": [ null ],
                "attribute-filter-group-name": "string",
                "attribute-filters": {
                  "attribute-filter": [
                    {
                      "attribute-start": "string",
                      "attribute-end": "string",
                      "filter-action": "string"
                    }
                  ]
                }
              }
            ]
          },
          "update-limit-process": "integer",
          "rpki-origin-as-validation-time": "integer",
          "nsr": "boolean",
          "read-only": [ null ],
          "graceful-restart-stalepath-time": "integer",
          "graceful-reset": [ null ],
          "update-out-logging": [ null ],
          "local-preference": "integer"
        }
      }
    }
  ]
}

FOUR-BYTE-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/

Update operation of resource: four-byte-as

four-byte-as_schema

four-byte-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "bgp-running": [ null ],
  "our-byte-as_as": "string",
  "vrfs": {
    "vrf": [
      {
        "vrf-global": {
          "route-distinguisher": {
            "as-index": "string",
            "address-index": "string",
            "as-xx": "string",
            "as": "string",
            "address": "string",
            "type": "string"
          },
          "exists": [ null ],
          "vrf-global-afs": {
            "vrf-global-af": [
              {
                "ibgp": {
                  "order-by-igp-metric": "boolean",
                  "paths-value": "integer",
                  "selective": "boolean",
                  "unequal-cost": "boolean"
                },
                "mvpn": {
                  "single-forwarder-selection": "string"
                },
                "rt-download": [ null ],
                "af-name": "string",
                "eibgp": {
                  "order-by-igp-metric": "boolean",
                  "paths-value": "integer",
                  "selective": "boolean",
                  "unequal-cost": "boolean"
                },
                "ebgp": {
                  "order-by-igp-metric": "boolean",
                  "paths-value": "integer",
                  "selective": "boolean",
                  "unequal-cost": "boolean"
                },
                "allow-vpn-default-originate": "boolean",
                "subscriber-routes": {
                  "default-metric": "string",
                  "route-policy-name": "string",
                  "not-used": "integer"
                }
              }
            ]
          },
          "local-preference": "integer"
        },
        "vrf-name": "string",
        "vrf-neighbors": {
          "vrf-neighbor-prefix-length": [
            {
              "neighbor-address": "string",
              "prefix-length": "integer"
            }
          ],
          "vrf-neighbor": [
            {
              "neighbor-address": "string"
            }
          ]
        }
      }
    ]
  },
  "default-vrf": {
    "global": {
      "mvpn": [ null ],
      "rpki-origin-as-validation-disable": [ null ],
      "rpki-static-routes": {
        "rpki-static-route": [
          {
            "addrress": "string",
            "as": "integer",
            "minimum": "integer",
            "maximum": "integer"
          }
        ]
      },
      "update-error-handling-extended-ibgp": [ null ],
      "install-diversion": [ null ],
      "attribute-filter-groups": {
        "attribute-filter-group": [
          {
            "enable": [ null ],
            "attribute-filter-group-name": "string",
            "attribute-filters": {
              "attribute-filter": [
                {
                  "attribute-start": "string",
                  "attribute-end": "string",
                  "filter-action": "string"
                }
              ]
            }
          }
        ]
      },
      "update-limit-process": "integer",
      "rpki-origin-as-validation-time": "integer",
      "nsr": "boolean",
      "read-only": [ null ],
      "graceful-restart-stalepath-time": "integer",
      "graceful-reset": [ null ],
      "update-out-logging": [ null ],
      "graceful-restart-time": "integer",
      "confederation-domain": {},
      "local-preference": "integer"
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FOUR-BYTE-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/

Create operation of resource: four-byte-as

four-byte-as_schema

four-byte-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "bgp-running": [ null ],
  "our-byte-as_as": "string",
  "vrfs": {
    "vrf": [
      {
        "vrf-global": {
          "route-distinguisher": {
            "as-index": "string",
            "address-index": "string",
            "as-xx": "string",
            "as": "string",
            "address": "string",
            "type": "string"
          },
          "exists": [ null ],
          "vrf-global-afs": {
            "vrf-global-af": [
              {
                "ibgp": {
                  "order-by-igp-metric": "boolean",
                  "paths-value": "integer",
                  "selective": "boolean",
                  "unequal-cost": "boolean"
                },
                "mvpn": {
                  "single-forwarder-selection": "string"
                },
                "rt-download": [ null ],
                "af-name": "string",
                "eibgp": {
                  "order-by-igp-metric": "boolean",
                  "paths-value": "integer",
                  "selective": "boolean",
                  "unequal-cost": "boolean"
                },
                "ebgp": {
                  "order-by-igp-metric": "boolean",
                  "paths-value": "integer",
                  "selective": "boolean",
                  "unequal-cost": "boolean"
                },
                "allow-vpn-default-originate": "boolean",
                "subscriber-routes": {
                  "default-metric": "string",
                  "route-policy-name": "string",
                  "not-used": "integer"
                }
              }
            ]
          },
          "local-preference": "integer"
        },
        "vrf-name": "string",
        "vrf-neighbors": {
          "vrf-neighbor-prefix-length": [
            {
              "neighbor-address": "string",
              "prefix-length": "integer"
            }
          ],
          "vrf-neighbor": [
            {
              "neighbor-address": "string"
            }
          ]
        }
      }
    ]
  },
  "default-vrf": {
    "global": {
      "mvpn": [ null ],
      "rpki-origin-as-validation-disable": [ null ],
      "rpki-static-routes": {
        "rpki-static-route": [
          {
            "addrress": "string",
            "as": "integer",
            "minimum": "integer",
            "maximum": "integer"
          }
        ]
      },
      "update-error-handling-extended-ibgp": [ null ],
      "install-diversion": [ null ],
      "attribute-filter-groups": {
        "attribute-filter-group": [
          {
            "enable": [ null ],
            "attribute-filter-group-name": "string",
            "attribute-filters": {
              "attribute-filter": [
                {
                  "attribute-start": "string",
                  "attribute-end": "string",
                  "filter-action": "string"
                }
              ]
            }
          }
        ]
      },
      "update-limit-process": "integer",
      "rpki-origin-as-validation-time": "integer",
      "nsr": "boolean",
      "read-only": [ null ],
      "graceful-restart-stalepath-time": "integer",
      "graceful-reset": [ null ],
      "update-out-logging": [ null ],
      "graceful-restart-time": "integer",
      "confederation-domain": {},
      "local-preference": "integer"
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FOUR-BYTE-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/

Delete operation of resource: four-byte-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FOUR-BYTE-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/

Retrieve operation of resource: four-byte-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

four-byte-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bgp-running": [ null ],
  "our-byte-as_as": "string",
  "vrfs": {
    "vrf": [
      {
        "vrf-global": {
          "route-distinguisher": {
            "as-index": "string",
            "address-index": "string",
            "as-xx": "string",
            "as": "string",
            "address": "string",
            "type": "string"
          },
          "exists": [ null ],
          "vrf-global-afs": {
            "vrf-global-af": [
              {
                "ibgp": {
                  "order-by-igp-metric": "boolean",
                  "paths-value": "integer",
                  "selective": "boolean",
                  "unequal-cost": "boolean"
                },
                "mvpn": {
                  "single-forwarder-selection": "string"
                },
                "rt-download": [ null ],
                "af-name": "string",
                "eibgp": {
                  "order-by-igp-metric": "boolean",
                  "paths-value": "integer",
                  "selective": "boolean",
                  "unequal-cost": "boolean"
                },
                "ebgp": {
                  "order-by-igp-metric": "boolean",
                  "paths-value": "integer",
                  "selective": "boolean",
                  "unequal-cost": "boolean"
                },
                "allow-vpn-default-originate": "boolean",
                "subscriber-routes": {
                  "default-metric": "string",
                  "route-policy-name": "string",
                  "not-used": "integer"
                }
              }
            ]
          },
          "local-preference": "integer"
        },
        "vrf-name": "string",
        "vrf-neighbors": {
          "vrf-neighbor-prefix-length": [
            {
              "neighbor-address": "string",
              "prefix-length": "integer"
            }
          ],
          "vrf-neighbor": [
            {
              "neighbor-address": "string"
            }
          ]
        }
      }
    ]
  },
  "default-vrf": {
    "global": {
      "mvpn": [ null ],
      "rpki-origin-as-validation-disable": [ null ],
      "rpki-static-routes": {
        "rpki-static-route": [
          {
            "addrress": "string",
            "as": "integer",
            "minimum": "integer",
            "maximum": "integer"
          }
        ]
      },
      "update-error-handling-extended-ibgp": [ null ],
      "install-diversion": [ null ],
      "attribute-filter-groups": {
        "attribute-filter-group": [
          {
            "enable": [ null ],
            "attribute-filter-group-name": "string",
            "attribute-filters": {
              "attribute-filter": [
                {
                  "attribute-start": "string",
                  "attribute-end": "string",
                  "filter-action": "string"
                }
              ]
            }
          }
        ]
      },
      "update-limit-process": "integer",
      "rpki-origin-as-validation-time": "integer",
      "nsr": "boolean",
      "read-only": [ null ],
      "graceful-restart-stalepath-time": "integer",
      "graceful-reset": [ null ],
      "update-out-logging": [ null ],
      "graceful-restart-time": "integer",
      "confederation-domain": {},
      "local-preference": "integer"
    }
  }
}

VRFS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/

Update operation of resource: vrfs

vrfs_schema

vrfsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "vrf": [
    {
      "vrf-global": {
        "route-distinguisher": {
          "as-index": "string",
          "address-index": "string",
          "as-xx": "string",
          "as": "string",
          "address": "string",
          "type": "string"
        },
        "exists": [ null ],
        "vrf-global-afs": {
          "vrf-global-af": [
            {
              "ibgp": {
                "order-by-igp-metric": "boolean",
                "paths-value": "integer",
                "selective": "boolean",
                "unequal-cost": "boolean"
              },
              "mvpn": {
                "single-forwarder-selection": "string"
              },
              "rt-download": [ null ],
              "af-name": "string",
              "eibgp": {
                "order-by-igp-metric": "boolean",
                "paths-value": "integer",
                "selective": "boolean",
                "unequal-cost": "boolean"
              },
              "ebgp": {
                "order-by-igp-metric": "boolean",
                "paths-value": "integer",
                "selective": "boolean",
                "unequal-cost": "boolean"
              },
              "allow-vpn-default-originate": "boolean",
              "subscriber-routes": {
                "default-metric": "string",
                "route-policy-name": "string",
                "not-used": "integer"
              }
            }
          ]
        },
        "local-preference": "integer"
      },
      "vrf-name": "string",
      "vrf-neighbors": {
        "vrf-neighbor-prefix-length": [
          {
            "neighbor-address": "string",
            "prefix-length": "integer"
          }
        ],
        "vrf-neighbor": [
          {
            "neighbor-address": "string"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/

Create operation of resource: vrfs

vrfs_schema

vrfsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "vrf": [
    {
      "vrf-global": {
        "route-distinguisher": {
          "as-index": "string",
          "address-index": "string",
          "as-xx": "string",
          "as": "string",
          "address": "string",
          "type": "string"
        },
        "exists": [ null ],
        "vrf-global-afs": {
          "vrf-global-af": [
            {
              "ibgp": {
                "order-by-igp-metric": "boolean",
                "paths-value": "integer",
                "selective": "boolean",
                "unequal-cost": "boolean"
              },
              "mvpn": {
                "single-forwarder-selection": "string"
              },
              "rt-download": [ null ],
              "af-name": "string",
              "eibgp": {
                "order-by-igp-metric": "boolean",
                "paths-value": "integer",
                "selective": "boolean",
                "unequal-cost": "boolean"
              },
              "ebgp": {
                "order-by-igp-metric": "boolean",
                "paths-value": "integer",
                "selective": "boolean",
                "unequal-cost": "boolean"
              },
              "allow-vpn-default-originate": "boolean",
              "subscriber-routes": {
                "default-metric": "string",
                "route-policy-name": "string",
                "not-used": "integer"
              }
            }
          ]
        },
        "local-preference": "integer"
      },
      "vrf-name": "string",
      "vrf-neighbors": {
        "vrf-neighbor-prefix-length": [
          {
            "neighbor-address": "string",
            "prefix-length": "integer"
          }
        ],
        "vrf-neighbor": [
          {
            "neighbor-address": "string"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/

Delete operation of resource: vrfs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/

Retrieve operation of resource: vrfs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "vrf": [
    {
      "vrf-global": {
        "route-distinguisher": {
          "as-index": "string",
          "address-index": "string",
          "as-xx": "string",
          "as": "string",
          "address": "string",
          "type": "string"
        },
        "exists": [ null ],
        "vrf-global-afs": {
          "vrf-global-af": [
            {
              "ibgp": {
                "order-by-igp-metric": "boolean",
                "paths-value": "integer",
                "selective": "boolean",
                "unequal-cost": "boolean"
              },
              "mvpn": {
                "single-forwarder-selection": "string"
              },
              "rt-download": [ null ],
              "af-name": "string",
              "eibgp": {
                "order-by-igp-metric": "boolean",
                "paths-value": "integer",
                "selective": "boolean",
                "unequal-cost": "boolean"
              },
              "ebgp": {
                "order-by-igp-metric": "boolean",
                "paths-value": "integer",
                "selective": "boolean",
                "unequal-cost": "boolean"
              },
              "allow-vpn-default-originate": "boolean",
              "subscriber-routes": {
                "default-metric": "string",
                "route-policy-name": "string",
                "not-used": "integer"
              }
            }
          ]
        },
        "local-preference": "integer"
      },
      "vrf-name": "string",
      "vrf-neighbors": {
        "vrf-neighbor-prefix-length": [
          {
            "neighbor-address": "string",
            "prefix-length": "integer"
          }
        ],
        "vrf-neighbor": [
          {
            "neighbor-address": "string"
          }
        ]
      }
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrf_schema

vrfbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "vrf-global": {
    "route-distinguisher": {
      "as-index": "string",
      "address-index": "string",
      "as-xx": "string",
      "as": "string",
      "address": "string",
      "type": "string"
    },
    "exists": [ null ],
    "vrf-global-afs": {
      "vrf-global-af": [
        {
          "ibgp": {
            "order-by-igp-metric": "boolean",
            "paths-value": "integer",
            "selective": "boolean",
            "unequal-cost": "boolean"
          },
          "mvpn": {
            "single-forwarder-selection": "string"
          },
          "rt-download": [ null ],
          "af-name": "string",
          "eibgp": {
            "order-by-igp-metric": "boolean",
            "paths-value": "integer",
            "selective": "boolean",
            "unequal-cost": "boolean"
          },
          "ebgp": {
            "order-by-igp-metric": "boolean",
            "paths-value": "integer",
            "selective": "boolean",
            "unequal-cost": "boolean"
          },
          "allow-vpn-default-originate": "boolean",
          "subscriber-routes": {
            "default-metric": "string",
            "route-policy-name": "string",
            "not-used": "integer"
          }
        }
      ]
    },
    "local-preference": "integer"
  },
  "vrf-name": "string",
  "vrf-neighbors": {
    "vrf-neighbor-prefix-length": [
      {
        "neighbor-address": "string",
        "prefix-length": "integer"
      }
    ],
    "vrf-neighbor": [
      {
        "neighbor-address": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrf_schema

vrfbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "vrf-global": {
    "route-distinguisher": {
      "as-index": "string",
      "address-index": "string",
      "as-xx": "string",
      "as": "string",
      "address": "string",
      "type": "string"
    },
    "exists": [ null ],
    "vrf-global-afs": {
      "vrf-global-af": [
        {
          "ibgp": {
            "order-by-igp-metric": "boolean",
            "paths-value": "integer",
            "selective": "boolean",
            "unequal-cost": "boolean"
          },
          "mvpn": {
            "single-forwarder-selection": "string"
          },
          "rt-download": [ null ],
          "af-name": "string",
          "eibgp": {
            "order-by-igp-metric": "boolean",
            "paths-value": "integer",
            "selective": "boolean",
            "unequal-cost": "boolean"
          },
          "ebgp": {
            "order-by-igp-metric": "boolean",
            "paths-value": "integer",
            "selective": "boolean",
            "unequal-cost": "boolean"
          },
          "allow-vpn-default-originate": "boolean",
          "subscriber-routes": {
            "default-metric": "string",
            "route-policy-name": "string",
            "not-used": "integer"
          }
        }
      ]
    },
    "local-preference": "integer"
  },
  "vrf-name": "string",
  "vrf-neighbors": {
    "vrf-neighbor-prefix-length": [
      {
        "neighbor-address": "string",
        "prefix-length": "integer"
      }
    ],
    "vrf-neighbor": [
      {
        "neighbor-address": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "vrf-global": {
    "route-distinguisher": {
      "as-index": "string",
      "address-index": "string",
      "as-xx": "string",
      "as": "string",
      "address": "string",
      "type": "string"
    },
    "exists": [ null ],
    "vrf-global-afs": {
      "vrf-global-af": [
        {
          "ibgp": {
            "order-by-igp-metric": "boolean",
            "paths-value": "integer",
            "selective": "boolean",
            "unequal-cost": "boolean"
          },
          "mvpn": {
            "single-forwarder-selection": "string"
          },
          "rt-download": [ null ],
          "af-name": "string",
          "eibgp": {
            "order-by-igp-metric": "boolean",
            "paths-value": "integer",
            "selective": "boolean",
            "unequal-cost": "boolean"
          },
          "ebgp": {
            "order-by-igp-metric": "boolean",
            "paths-value": "integer",
            "selective": "boolean",
            "unequal-cost": "boolean"
          },
          "allow-vpn-default-originate": "boolean",
          "subscriber-routes": {
            "default-metric": "string",
            "route-policy-name": "string",
            "not-used": "integer"
          }
        }
      ]
    },
    "local-preference": "integer"
  },
  "vrf-name": "string",
  "vrf-neighbors": {
    "vrf-neighbor-prefix-length": [
      {
        "neighbor-address": "string",
        "prefix-length": "integer"
      }
    ],
    "vrf-neighbor": [
      {
        "neighbor-address": "string"
      }
    ]
  }
}

VRF-GLOBAL - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/

Update operation of resource: vrf-global

vrf-global_schema

vrf-globalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "route-distinguisher": {
    "as-index": "string",
    "address-index": "string",
    "as-xx": "string",
    "as": "string",
    "address": "string",
    "type": "string"
  },
  "exists": [ null ],
  "vrf-global-afs": {
    "vrf-global-af": [
      {
        "ibgp": {
          "order-by-igp-metric": "boolean",
          "paths-value": "integer",
          "selective": "boolean",
          "unequal-cost": "boolean"
        },
        "mvpn": {
          "single-forwarder-selection": "string"
        },
        "rt-download": [ null ],
        "af-name": "string",
        "eibgp": {
          "order-by-igp-metric": "boolean",
          "paths-value": "integer",
          "selective": "boolean",
          "unequal-cost": "boolean"
        },
        "ebgp": {
          "order-by-igp-metric": "boolean",
          "paths-value": "integer",
          "selective": "boolean",
          "unequal-cost": "boolean"
        },
        "allow-vpn-default-originate": "boolean",
        "subscriber-routes": {
          "default-metric": "string",
          "route-policy-name": "string",
          "not-used": "integer"
        }
      }
    ]
  },
  "local-preference": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/

Create operation of resource: vrf-global

vrf-global_schema

vrf-globalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "route-distinguisher": {
    "as-index": "string",
    "address-index": "string",
    "as-xx": "string",
    "as": "string",
    "address": "string",
    "type": "string"
  },
  "exists": [ null ],
  "vrf-global-afs": {
    "vrf-global-af": [
      {
        "ibgp": {
          "order-by-igp-metric": "boolean",
          "paths-value": "integer",
          "selective": "boolean",
          "unequal-cost": "boolean"
        },
        "mvpn": {
          "single-forwarder-selection": "string"
        },
        "rt-download": [ null ],
        "af-name": "string",
        "eibgp": {
          "order-by-igp-metric": "boolean",
          "paths-value": "integer",
          "selective": "boolean",
          "unequal-cost": "boolean"
        },
        "ebgp": {
          "order-by-igp-metric": "boolean",
          "paths-value": "integer",
          "selective": "boolean",
          "unequal-cost": "boolean"
        },
        "allow-vpn-default-originate": "boolean",
        "subscriber-routes": {
          "default-metric": "string",
          "route-policy-name": "string",
          "not-used": "integer"
        }
      }
    ]
  },
  "local-preference": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/

Delete operation of resource: vrf-global

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/

Retrieve operation of resource: vrf-global

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

vrf-global_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "route-distinguisher": {
    "as-index": "string",
    "address-index": "string",
    "as-xx": "string",
    "as": "string",
    "address": "string",
    "type": "string"
  },
  "exists": [ null ],
  "vrf-global-afs": {
    "vrf-global-af": [
      {
        "ibgp": {
          "order-by-igp-metric": "boolean",
          "paths-value": "integer",
          "selective": "boolean",
          "unequal-cost": "boolean"
        },
        "mvpn": {
          "single-forwarder-selection": "string"
        },
        "rt-download": [ null ],
        "af-name": "string",
        "eibgp": {
          "order-by-igp-metric": "boolean",
          "paths-value": "integer",
          "selective": "boolean",
          "unequal-cost": "boolean"
        },
        "ebgp": {
          "order-by-igp-metric": "boolean",
          "paths-value": "integer",
          "selective": "boolean",
          "unequal-cost": "boolean"
        },
        "allow-vpn-default-originate": "boolean",
        "subscriber-routes": {
          "default-metric": "string",
          "route-policy-name": "string",
          "not-used": "integer"
        }
      }
    ]
  },
  "local-preference": "integer"
}

ROUTE-DISTINGUISHER - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/route-distinguisher/

Update operation of resource: route-distinguisher

route-distinguisher_schema

route-distinguisherbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-DISTINGUISHER - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/route-distinguisher/

Create operation of resource: route-distinguisher

route-distinguisher_schema

route-distinguisherbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-DISTINGUISHER - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/route-distinguisher/

Delete operation of resource: route-distinguisher

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-DISTINGUISHER - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/route-distinguisher/

Retrieve operation of resource: route-distinguisher

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

route-distinguisher_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

VRF-GLOBAL-AFS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/

Update operation of resource: vrf-global-afs

vrf-global-afs_schema

vrf-global-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "vrf-global-af": [
    {
      "ibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "mvpn": {
        "single-forwarder-selection": "string"
      },
      "rt-download": [ null ],
      "af-name": "string",
      "eibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "ebgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "allow-vpn-default-originate": "boolean",
      "subscriber-routes": {
        "default-metric": "string",
        "route-policy-name": "string",
        "not-used": "integer"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL-AFS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/

Create operation of resource: vrf-global-afs

vrf-global-afs_schema

vrf-global-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "vrf-global-af": [
    {
      "ibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "mvpn": {
        "single-forwarder-selection": "string"
      },
      "rt-download": [ null ],
      "af-name": "string",
      "eibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "ebgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "allow-vpn-default-originate": "boolean",
      "subscriber-routes": {
        "default-metric": "string",
        "route-policy-name": "string",
        "not-used": "integer"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL-AFS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/

Delete operation of resource: vrf-global-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL-AFS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/

Retrieve operation of resource: vrf-global-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

vrf-global-afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "vrf-global-af": [
    {
      "ibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "mvpn": {
        "single-forwarder-selection": "string"
      },
      "rt-download": [ null ],
      "af-name": "string",
      "eibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "ebgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "allow-vpn-default-originate": "boolean",
      "subscriber-routes": {
        "default-metric": "string",
        "route-policy-name": "string",
        "not-used": "integer"
      }
    }
  ]
}

VRF-GLOBAL-AF - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/

Update operation of resource: vrf-global-af

vrf-global-af_schema

vrf-global-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "ibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "mvpn": {
    "single-forwarder-selection": "string"
  },
  "rt-download": [ null ],
  "af-name": "string",
  "eibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "ebgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "allow-vpn-default-originate": "boolean",
  "subscriber-routes": {
    "default-metric": "string",
    "route-policy-name": "string",
    "not-used": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL-AF - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/

Create operation of resource: vrf-global-af

vrf-global-af_schema

vrf-global-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "ibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "mvpn": {
    "single-forwarder-selection": "string"
  },
  "rt-download": [ null ],
  "af-name": "string",
  "eibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "ebgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "allow-vpn-default-originate": "boolean",
  "subscriber-routes": {
    "default-metric": "string",
    "route-policy-name": "string",
    "not-used": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL-AF - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/

Delete operation of resource: vrf-global-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL-AF - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/

Retrieve operation of resource: vrf-global-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

vrf-global-af_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "ibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "mvpn": {
    "single-forwarder-selection": "string"
  },
  "rt-download": [ null ],
  "af-name": "string",
  "eibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "ebgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "allow-vpn-default-originate": "boolean",
  "subscriber-routes": {
    "default-metric": "string",
    "route-policy-name": "string",
    "not-used": "integer"
  }
}

MVPN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/mvpn/

Update operation of resource: mvpn

mvpn_schema

mvpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "single-forwarder-selection": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MVPN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/mvpn/

Create operation of resource: mvpn

mvpn_schema

mvpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "single-forwarder-selection": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MVPN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/mvpn/

Delete operation of resource: mvpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MVPN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/mvpn/

Retrieve operation of resource: mvpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

mvpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "single-forwarder-selection": "string"
}

EBGP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ebgp/

Update operation of resource: ebgp

ebgp_schema

ebgpbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ebgp/

Create operation of resource: ebgp

ebgp_schema

ebgpbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ebgp/

Delete operation of resource: ebgp

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ebgp/

Retrieve operation of resource: ebgp

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

ebgp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

EIBGP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eibgp/

Update operation of resource: eibgp

eibgp_schema

eibgpbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIBGP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eibgp/

Create operation of resource: eibgp

eibgp_schema

eibgpbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIBGP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eibgp/

Delete operation of resource: eibgp

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIBGP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eibgp/

Retrieve operation of resource: eibgp

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

eibgp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

IBGP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ibgp/

Update operation of resource: ibgp

ibgp_schema

ibgpbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IBGP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ibgp/

Create operation of resource: ibgp

ibgp_schema

ibgpbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IBGP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ibgp/

Delete operation of resource: ibgp

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IBGP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ibgp/

Retrieve operation of resource: ibgp

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

ibgp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

AGGREGATE-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/

Update operation of resource: aggregate-addresses

aggregate-addresses_schema

aggregate-addressesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "aggregate-address": [
    {
      "route-policy-name": "string",
      "aggregate-prefix": "integer",
      "summary-only": "boolean",
      "generate-set-info": "boolean",
      "generate-confederation-set-info": "boolean",
      "aggregate-addr": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/

Create operation of resource: aggregate-addresses

aggregate-addresses_schema

aggregate-addressesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "aggregate-address": [
    {
      "route-policy-name": "string",
      "aggregate-prefix": "integer",
      "summary-only": "boolean",
      "generate-set-info": "boolean",
      "generate-confederation-set-info": "boolean",
      "aggregate-addr": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/

Delete operation of resource: aggregate-addresses

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/

Retrieve operation of resource: aggregate-addresses

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

aggregate-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "aggregate-address": [
    {
      "route-policy-name": "string",
      "aggregate-prefix": "integer",
      "summary-only": "boolean",
      "generate-set-info": "boolean",
      "generate-confederation-set-info": "boolean",
      "aggregate-addr": "string"
    }
  ]
}

AGGREGATE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/aggregate-address/{aggregate-addr aggregate-prefix}/

Update operation of resource: aggregate-address

aggregate-address_schema

aggregate-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

aggregate-addr aggregate-prefix

in path

string

ID of aggregate-addr aggregate-prefix

Request Content-Types: application/json

Request Example

{
  "route-policy-name": "string",
  "aggregate-prefix": "integer",
  "summary-only": "boolean",
  "generate-set-info": "boolean",
  "generate-confederation-set-info": "boolean",
  "aggregate-addr": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/aggregate-address/{aggregate-addr aggregate-prefix}/

Create operation of resource: aggregate-address

aggregate-address_schema

aggregate-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

aggregate-addr aggregate-prefix

in path

string

ID of aggregate-addr aggregate-prefix

Request Content-Types: application/json

Request Example

{
  "route-policy-name": "string",
  "aggregate-prefix": "integer",
  "summary-only": "boolean",
  "generate-set-info": "boolean",
  "generate-confederation-set-info": "boolean",
  "aggregate-addr": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/aggregate-address/{aggregate-addr aggregate-prefix}/

Delete operation of resource: aggregate-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

aggregate-addr aggregate-prefix

in path

string

ID of aggregate-addr aggregate-prefix

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/aggregate-address/{aggregate-addr aggregate-prefix}/

Retrieve operation of resource: aggregate-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

aggregate-addr aggregate-prefix

in path

string

ID of aggregate-addr aggregate-prefix

200 OK

aggregate-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "route-policy-name": "string",
  "aggregate-prefix": "integer",
  "summary-only": "boolean",
  "generate-set-info": "boolean",
  "generate-confederation-set-info": "boolean",
  "aggregate-addr": "string"
}

OPTIMAL-ROUTE-REFLECTOR-GROUPS - Update

Update operation of resource: optimal-route-reflector-groups

optimal-route-reflector-groups_schema

optimal-route-reflector-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "optimal-route-reflector-group": [
    {
      "primary-root-address": "string",
      "group-name": "string",
      "tertiary-root-address": "string",
      "secondary-root-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUPS - Create

Create operation of resource: optimal-route-reflector-groups

optimal-route-reflector-groups_schema

optimal-route-reflector-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "optimal-route-reflector-group": [
    {
      "primary-root-address": "string",
      "group-name": "string",
      "tertiary-root-address": "string",
      "secondary-root-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUPS - Delete

Delete operation of resource: optimal-route-reflector-groups

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUPS - Retrieve

Retrieve operation of resource: optimal-route-reflector-groups

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

optimal-route-reflector-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "optimal-route-reflector-group": [
    {
      "primary-root-address": "string",
      "group-name": "string",
      "tertiary-root-address": "string",
      "secondary-root-address": "string"
    }
  ]
}

OPTIMAL-ROUTE-REFLECTOR-GROUP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/optimal-route-reflector-groups/optimal-route-reflector-group/{group-name}/

Update operation of resource: optimal-route-reflector-group

optimal-route-reflector-group_schema

optimal-route-reflector-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

group-name

in path

string

ID of group-name

Request Content-Types: application/json

Request Example

{
  "primary-root-address": "string",
  "group-name": "string",
  "tertiary-root-address": "string",
  "secondary-root-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/optimal-route-reflector-groups/optimal-route-reflector-group/{group-name}/

Create operation of resource: optimal-route-reflector-group

optimal-route-reflector-group_schema

optimal-route-reflector-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

group-name

in path

string

ID of group-name

Request Content-Types: application/json

Request Example

{
  "primary-root-address": "string",
  "group-name": "string",
  "tertiary-root-address": "string",
  "secondary-root-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/optimal-route-reflector-groups/optimal-route-reflector-group/{group-name}/

Delete operation of resource: optimal-route-reflector-group

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

group-name

in path

string

ID of group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/optimal-route-reflector-groups/optimal-route-reflector-group/{group-name}/

Retrieve operation of resource: optimal-route-reflector-group

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

group-name

in path

string

ID of group-name

200 OK

optimal-route-reflector-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "primary-root-address": "string",
  "group-name": "string",
  "tertiary-root-address": "string",
  "secondary-root-address": "string"
}

DAMPENING - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/dampening/

Update operation of resource: dampening

dampening_schema

dampeningbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "reuse-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "suppress-threshold": "integer",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/dampening/

Create operation of resource: dampening

dampening_schema

dampeningbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "reuse-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "suppress-threshold": "integer",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/dampening/

Delete operation of resource: dampening

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/dampening/

Retrieve operation of resource: dampening

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

dampening_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "reuse-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "suppress-threshold": "integer",
  "route-policy-name": "string"
}

RIP-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/rip-routes/

Update operation of resource: rip-routes

rip-routes_schema

rip-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RIP-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/rip-routes/

Create operation of resource: rip-routes

rip-routes_schema

rip-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RIP-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/rip-routes/

Delete operation of resource: rip-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RIP-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/rip-routes/

Retrieve operation of resource: rip-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

rip-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

LISP-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/lisp-routes/

Update operation of resource: lisp-routes

lisp-routes_schema

lisp-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LISP-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/lisp-routes/

Create operation of resource: lisp-routes

lisp-routes_schema

lisp-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LISP-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/lisp-routes/

Delete operation of resource: lisp-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LISP-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/lisp-routes/

Retrieve operation of resource: lisp-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

lisp-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string"
}

STATIC-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/static-routes/

Update operation of resource: static-routes

static-routes_schema

static-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/static-routes/

Create operation of resource: static-routes

static-routes_schema

static-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/static-routes/

Delete operation of resource: static-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/static-routes/

Retrieve operation of resource: static-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

static-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

DISTANCE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/distance/

Update operation of resource: distance

distance_schema

distancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "external-routes": "integer",
  "local-routes": "integer",
  "internal-routes": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISTANCE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/distance/

Create operation of resource: distance

distance_schema

distancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "external-routes": "integer",
  "local-routes": "integer",
  "internal-routes": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISTANCE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/distance/

Delete operation of resource: distance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISTANCE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/distance/

Retrieve operation of resource: distance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

distance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "external-routes": "integer",
  "local-routes": "integer",
  "internal-routes": "integer"
}

APPLICATION-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/

Update operation of resource: application-routes

application-routes_schema

application-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "application-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "instance-name": "string",
      "not-used": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/

Create operation of resource: application-routes

application-routes_schema

application-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "application-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "instance-name": "string",
      "not-used": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/

Delete operation of resource: application-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/

Retrieve operation of resource: application-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

application-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "application-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "instance-name": "string",
      "not-used": "integer"
    }
  ]
}

APPLICATION-ROUTE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/application-route/{instance-name}/

Update operation of resource: application-route

application-route_schema

application-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "instance-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/application-route/{instance-name}/

Create operation of resource: application-route

application-route_schema

application-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "instance-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/application-route/{instance-name}/

Delete operation of resource: application-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/application-route/{instance-name}/

Retrieve operation of resource: application-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

application-route_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "instance-name": "string",
  "not-used": "integer"
}

LABEL-MODE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/label-mode/

Update operation of resource: label-mode

label-mode_schema

label-modebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "route-policy-name": "string",
  "label-allocation-mode": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-MODE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/label-mode/

Create operation of resource: label-mode

label-mode_schema

label-modebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "route-policy-name": "string",
  "label-allocation-mode": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-MODE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/label-mode/

Delete operation of resource: label-mode

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-MODE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/label-mode/

Retrieve operation of resource: label-mode

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

label-mode_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "route-policy-name": "string",
  "label-allocation-mode": "string"
}

EIGRP-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eigrp-routes/

Update operation of resource: eigrp-routes

eigrp-routes_schema

eigrp-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "eigrp-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eigrp-routes/

Create operation of resource: eigrp-routes

eigrp-routes_schema

eigrp-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "eigrp-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eigrp-routes/

Delete operation of resource: eigrp-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eigrp-routes/

Retrieve operation of resource: eigrp-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

eigrp-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "eigrp-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

EIGRP-ROUTE - Update

Update operation of resource: eigrp-route

eigrp-route_schema

eigrp-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTE - Create

Create operation of resource: eigrp-route

eigrp-route_schema

eigrp-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTE - Delete

Delete operation of resource: eigrp-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTE - Retrieve

Retrieve operation of resource: eigrp-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

eigrp-route_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

SOURCED-NETWORKS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/sourced-networks/

Update operation of resource: sourced-networks

sourced-networks_schema

sourced-networksbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "sourced-network": [
    {
      "network-prefix": "integer",
      "route-policy-name": "string",
      "network-addr": "string",
      "backdoor": "boolean"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORKS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/sourced-networks/

Create operation of resource: sourced-networks

sourced-networks_schema

sourced-networksbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "sourced-network": [
    {
      "network-prefix": "integer",
      "route-policy-name": "string",
      "network-addr": "string",
      "backdoor": "boolean"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORKS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/sourced-networks/

Delete operation of resource: sourced-networks

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORKS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/sourced-networks/

Retrieve operation of resource: sourced-networks

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

sourced-networks_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "sourced-network": [
    {
      "network-prefix": "integer",
      "route-policy-name": "string",
      "network-addr": "string",
      "backdoor": "boolean"
    }
  ]
}

SOURCED-NETWORK - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/sourced-networks/sourced-network/{network-addr network-prefix}/

Update operation of resource: sourced-network

sourced-network_schema

sourced-networkbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

network-addr network-prefix

in path

string

ID of network-addr network-prefix

Request Content-Types: application/json

Request Example

{
  "network-prefix": "integer",
  "route-policy-name": "string",
  "network-addr": "string",
  "backdoor": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORK - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/sourced-networks/sourced-network/{network-addr network-prefix}/

Create operation of resource: sourced-network

sourced-network_schema

sourced-networkbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

network-addr network-prefix

in path

string

ID of network-addr network-prefix

Request Content-Types: application/json

Request Example

{
  "network-prefix": "integer",
  "route-policy-name": "string",
  "network-addr": "string",
  "backdoor": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORK - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/sourced-networks/sourced-network/{network-addr network-prefix}/

Delete operation of resource: sourced-network

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

network-addr network-prefix

in path

string

ID of network-addr network-prefix

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORK - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/sourced-networks/sourced-network/{network-addr network-prefix}/

Retrieve operation of resource: sourced-network

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

network-addr network-prefix

in path

string

ID of network-addr network-prefix

200 OK

sourced-network_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "network-prefix": "integer",
  "route-policy-name": "string",
  "network-addr": "string",
  "backdoor": "boolean"
}

CONNECTED-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/connected-routes/

Update operation of resource: connected-routes

connected-routes_schema

connected-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONNECTED-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/connected-routes/

Create operation of resource: connected-routes

connected-routes_schema

connected-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONNECTED-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/connected-routes/

Delete operation of resource: connected-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONNECTED-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/connected-routes/

Retrieve operation of resource: connected-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

connected-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

ALLOCATE-LABEL - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/allocate-label/

Update operation of resource: allocate-label

allocate-label_schema

allocate-labelbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "all": "boolean",
  "route-policy-name": "string",
  "un-labeled-path": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOCATE-LABEL - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/allocate-label/

Create operation of resource: allocate-label

allocate-label_schema

allocate-labelbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "all": "boolean",
  "route-policy-name": "string",
  "un-labeled-path": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOCATE-LABEL - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/allocate-label/

Delete operation of resource: allocate-label

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOCATE-LABEL - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/allocate-label/

Retrieve operation of resource: allocate-label

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

allocate-label_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "all": "boolean",
  "route-policy-name": "string",
  "un-labeled-path": "boolean"
}

ADDITIONAL-PATHS-SELECTION - Update

Update operation of resource: additional-paths-selection

additional-paths-selection_schema

additional-paths-selectionbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "selection": "string",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDITIONAL-PATHS-SELECTION - Create

Create operation of resource: additional-paths-selection

additional-paths-selection_schema

additional-paths-selectionbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "selection": "string",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDITIONAL-PATHS-SELECTION - Delete

Delete operation of resource: additional-paths-selection

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDITIONAL-PATHS-SELECTION - Retrieve

Retrieve operation of resource: additional-paths-selection

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

additional-paths-selection_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "selection": "string",
  "route-policy-name": "string"
}

OSPF-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ospf-routes/

Update operation of resource: ospf-routes

ospf-routes_schema

ospf-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "ospf-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OSPF-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ospf-routes/

Create operation of resource: ospf-routes

ospf-routes_schema

ospf-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "ospf-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OSPF-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ospf-routes/

Delete operation of resource: ospf-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OSPF-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ospf-routes/

Retrieve operation of resource: ospf-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

ospf-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "ospf-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

OSPF-ROUTE - Update

Update operation of resource: ospf-route

ospf-route_schema

ospf-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OSPF-ROUTE - Create

Create operation of resource: ospf-route

ospf-route_schema

ospf-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OSPF-ROUTE - Delete

Delete operation of resource: ospf-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OSPF-ROUTE - Retrieve

Retrieve operation of resource: ospf-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

ospf-route_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

MOBILE-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/mobile-routes/

Update operation of resource: mobile-routes

mobile-routes_schema

mobile-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MOBILE-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/mobile-routes/

Create operation of resource: mobile-routes

mobile-routes_schema

mobile-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MOBILE-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/mobile-routes/

Delete operation of resource: mobile-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MOBILE-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/mobile-routes/

Retrieve operation of resource: mobile-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

mobile-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

SUBSCRIBER-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/subscriber-routes/

Update operation of resource: subscriber-routes

subscriber-routes_schema

subscriber-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SUBSCRIBER-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/subscriber-routes/

Create operation of resource: subscriber-routes

subscriber-routes_schema

subscriber-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SUBSCRIBER-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/subscriber-routes/

Delete operation of resource: subscriber-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SUBSCRIBER-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/subscriber-routes/

Retrieve operation of resource: subscriber-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

af-name

in path

string

ID of af-name

200 OK

subscriber-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

MPLS-ACTIVATED-INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/mpls-activated-interfaces/

Update operation of resource: mpls-activated-interfaces

mpls-activated-interfaces_schema

mpls-activated-interfacesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "mpls-activated-interface": [
    {
      "interface-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-ACTIVATED-INTERFACES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/mpls-activated-interfaces/

Create operation of resource: mpls-activated-interfaces

mpls-activated-interfaces_schema

mpls-activated-interfacesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "mpls-activated-interface": [
    {
      "interface-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-ACTIVATED-INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/mpls-activated-interfaces/

Delete operation of resource: mpls-activated-interfaces

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-ACTIVATED-INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/mpls-activated-interfaces/

Retrieve operation of resource: mpls-activated-interfaces

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

mpls-activated-interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "mpls-activated-interface": [
    {
      "interface-name": "string"
    }
  ]
}

MPLS-ACTIVATED-INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/mpls-activated-interfaces/mpls-activated-interface/{interface-name}/

Update operation of resource: mpls-activated-interface

mpls-activated-interface_schema

mpls-activated-interfacebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

interface-name

in path

string

ID of interface-name

Request Content-Types: application/json

Request Example

{
  "interface-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-ACTIVATED-INTERFACE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/mpls-activated-interfaces/mpls-activated-interface/{interface-name}/

Create operation of resource: mpls-activated-interface

mpls-activated-interface_schema

mpls-activated-interfacebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

interface-name

in path

string

ID of interface-name

Request Content-Types: application/json

Request Example

{
  "interface-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-ACTIVATED-INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/mpls-activated-interfaces/mpls-activated-interface/{interface-name}/

Delete operation of resource: mpls-activated-interface

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

interface-name

in path

string

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-ACTIVATED-INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/mpls-activated-interfaces/mpls-activated-interface/{interface-name}/

Retrieve operation of resource: mpls-activated-interface

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

interface-name

in path

string

ID of interface-name

200 OK

mpls-activated-interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "interface-name": "string"
}

GLOBAL-TIMERS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/global-timers/

Update operation of resource: global-timers

global-timers_schema

global-timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "hold-time": "integer",
  "keepalive": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-TIMERS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/global-timers/

Create operation of resource: global-timers

global-timers_schema

global-timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "hold-time": "integer",
  "keepalive": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-TIMERS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/global-timers/

Delete operation of resource: global-timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-TIMERS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/global-timers/

Retrieve operation of resource: global-timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

global-timers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "min-accept-hold-time": "integer",
  "hold-time": "integer",
  "keepalive": "integer"
}

BFD - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/bfd/

Update operation of resource: bfd

bfd_schema

bfdbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "detection-multiplier": "integer",
  "interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/bfd/

Create operation of resource: bfd

bfd_schema

bfdbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "detection-multiplier": "integer",
  "interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/bfd/

Delete operation of resource: bfd

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/bfd/

Retrieve operation of resource: bfd

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

bfd_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "detection-multiplier": "integer",
  "interval": "integer"
}

SEND-SOCKET-BUFFER-SIZES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/send-socket-buffer-sizes/

Update operation of resource: send-socket-buffer-sizes

send-socket-buffer-sizes_schema

send-socket-buffer-sizesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-SOCKET-BUFFER-SIZES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/send-socket-buffer-sizes/

Create operation of resource: send-socket-buffer-sizes

send-socket-buffer-sizes_schema

send-socket-buffer-sizesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-SOCKET-BUFFER-SIZES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/send-socket-buffer-sizes/

Delete operation of resource: send-socket-buffer-sizes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-SOCKET-BUFFER-SIZES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/send-socket-buffer-sizes/

Retrieve operation of resource: send-socket-buffer-sizes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

send-socket-buffer-sizes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

RECEIVE-SOCKET-BUFFER-SIZES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/receive-socket-buffer-sizes/

Update operation of resource: receive-socket-buffer-sizes

receive-socket-buffer-sizes_schema

receive-socket-buffer-sizesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-SOCKET-BUFFER-SIZES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/receive-socket-buffer-sizes/

Create operation of resource: receive-socket-buffer-sizes

receive-socket-buffer-sizes_schema

receive-socket-buffer-sizesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-SOCKET-BUFFER-SIZES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/receive-socket-buffer-sizes/

Delete operation of resource: receive-socket-buffer-sizes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-SOCKET-BUFFER-SIZES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/receive-socket-buffer-sizes/

Retrieve operation of resource: receive-socket-buffer-sizes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

receive-socket-buffer-sizes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

VRF-NEIGHBORS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/

Update operation of resource: vrf-neighbors

vrf-neighbors_schema

vrf-neighborsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "vrf-neighbor-prefix-length": [
    {
      "neighbor-address": "string",
      "prefix-length": "integer"
    }
  ],
  "vrf-neighbor": [
    {
      "neighbor-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBORS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/

Create operation of resource: vrf-neighbors

vrf-neighbors_schema

vrf-neighborsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "vrf-neighbor-prefix-length": [
    {
      "neighbor-address": "string",
      "prefix-length": "integer"
    }
  ],
  "vrf-neighbor": [
    {
      "neighbor-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBORS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/

Delete operation of resource: vrf-neighbors

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBORS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/

Retrieve operation of resource: vrf-neighbors

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

200 OK

vrf-neighbors_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "vrf-neighbor-prefix-length": [
    {
      "neighbor-address": "string",
      "prefix-length": "integer"
    }
  ],
  "vrf-neighbor": [
    {
      "neighbor-address": "string"
    }
  ]
}

VRF-NEIGHBOR - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/

Update operation of resource: vrf-neighbor

vrf-neighbor_schema

vrf-neighborbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "neighbor-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/

Create operation of resource: vrf-neighbor

vrf-neighbor_schema

vrf-neighborbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "neighbor-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/

Delete operation of resource: vrf-neighbor

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/

Retrieve operation of resource: vrf-neighbor

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

vrf-neighbor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "neighbor-address": "string"
}

VRF-NEIGHBOR-AFS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/vrf-neighbor-afs/

Update operation of resource: vrf-neighbor-afs

vrf-neighbor-afs_schema

vrf-neighbor-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "vrf-neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-AFS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/vrf-neighbor-afs/

Create operation of resource: vrf-neighbor-afs

vrf-neighbor-afs_schema

vrf-neighbor-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "vrf-neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-AFS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/vrf-neighbor-afs/

Delete operation of resource: vrf-neighbor-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-AFS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/vrf-neighbor-afs/

Retrieve operation of resource: vrf-neighbor-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

vrf-neighbor-afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "vrf-neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

VRF-NEIGHBOR-AF - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/

Update operation of resource: vrf-neighbor-af

ADVERTISE-VRF-IMP-DISABLE-V4

vrf-neighbor-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-AF - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/

Create operation of resource: vrf-neighbor-af

ADVERTISE-VRF-IMP-DISABLE-V4

vrf-neighbor-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-AF - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/

Delete operation of resource: vrf-neighbor-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-AF - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/

Retrieve operation of resource: vrf-neighbor-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

ADVERTISE-VRF-IMP-DISABLE-V4

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

AIGP-COST-COMMUNITY - Update

Update operation of resource: aigp-cost-community

aigp-cost-community_schema

aigp-cost-communitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Create

Create operation of resource: aigp-cost-community

aigp-cost-community_schema

aigp-cost-communitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Delete

Delete operation of resource: aigp-cost-community

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Retrieve

Retrieve operation of resource: aigp-cost-community

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

aigp-cost-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

ADVERTISE-DEF-IMP-DISABLE-V6 - Update

Update operation of resource: advertise-def-imp-disable-v6

advertise-def-imp-disable-v6_schema

advertise-def-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Create

Create operation of resource: advertise-def-imp-disable-v6

advertise-def-imp-disable-v6_schema

advertise-def-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Delete

Delete operation of resource: advertise-def-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Retrieve

Retrieve operation of resource: advertise-def-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-def-imp-disable-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-DISABLE - Update

Update operation of resource: advertise-disable

advertise-disable_schema

advertise-disablebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Create

Create operation of resource: advertise-disable

advertise-disable_schema

advertise-disablebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Delete

Delete operation of resource: advertise-disable

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Retrieve

Retrieve operation of resource: advertise-disable

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-disable_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

MAXIMUM-PREFIXES - Update

Update operation of resource: maximum-prefixes

maximum-prefixes_schema

maximum-prefixesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Create

Create operation of resource: maximum-prefixes

maximum-prefixes_schema

maximum-prefixesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Delete

Delete operation of resource: maximum-prefixes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Retrieve

Retrieve operation of resource: maximum-prefixes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

maximum-prefixes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Update

Update operation of resource: remove-private-as-entire-as-path-inbound

remove-private-as-entire-as-path-inbound_schema

remove-private-as-entire-as-path-inboundbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Create

Create operation of resource: remove-private-as-entire-as-path-inbound

remove-private-as-entire-as-path-inbound_schema

remove-private-as-entire-as-path-inboundbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Delete

Delete operation of resource: remove-private-as-entire-as-path-inbound

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Retrieve

Retrieve operation of resource: remove-private-as-entire-as-path-inbound

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

remove-private-as-entire-as-path-inbound_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "entire": "boolean",
  "enable": "boolean"
}

ADVERTISE-DEF-IMP-DISABLE-V4 - Update

Update operation of resource: advertise-def-imp-disable-v4

advertise-def-imp-disable-v4_schema

advertise-def-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Create

Create operation of resource: advertise-def-imp-disable-v4

advertise-def-imp-disable-v4_schema

advertise-def-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Delete

Delete operation of resource: advertise-def-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Retrieve

Retrieve operation of resource: advertise-def-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-def-imp-disable-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-L2VPN-EVPN - Update

Update operation of resource: advertise-l2vpn-evpn

advertise-l2vpn-evpn_schema

advertise-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Create

Create operation of resource: advertise-l2vpn-evpn

advertise-l2vpn-evpn_schema

advertise-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Delete

Delete operation of resource: advertise-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Retrieve

Retrieve operation of resource: advertise-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-l2vpn-evpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-L2VPN-EVPN - Update

Update operation of resource: advertise-local-l2vpn-evpn

advertise-local-l2vpn-evpn_schema

advertise-local-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Create

Create operation of resource: advertise-local-l2vpn-evpn

advertise-local-l2vpn-evpn_schema

advertise-local-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Delete

Delete operation of resource: advertise-local-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Retrieve

Retrieve operation of resource: advertise-local-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-local-l2vpn-evpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Update

Update operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

neighbor-af-long-lived-graceful-restart-stale-time_schema

neighbor-af-long-lived-graceful-restart-stale-timebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Create

Create operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

neighbor-af-long-lived-graceful-restart-stale-time_schema

neighbor-af-long-lived-graceful-restart-stale-timebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Delete

Delete operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Retrieve

Retrieve operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

neighbor-af-long-lived-graceful-restart-stale-time_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

SITE-OF-ORIGIN - Update

Update operation of resource: site-of-origin

site-of-origin_schema

site-of-originbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SITE-OF-ORIGIN - Create

Create operation of resource: site-of-origin

site-of-origin_schema

site-of-originbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SITE-OF-ORIGIN - Delete

Delete operation of resource: site-of-origin

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SITE-OF-ORIGIN - Retrieve

Retrieve operation of resource: site-of-origin

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

site-of-origin_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

ADVERTISE-V6 - Update

Update operation of resource: advertise-v6

advertise-v6_schema

advertise-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Create

Create operation of resource: advertise-v6

advertise-v6_schema

advertise-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Delete

Delete operation of resource: advertise-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Retrieve

Retrieve operation of resource: advertise-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-V6 - Update

Update operation of resource: advertise-local-v6

advertise-local-v6_schema

advertise-local-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Create

Create operation of resource: advertise-local-v6

advertise-local-v6_schema

advertise-local-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Delete

Delete operation of resource: advertise-local-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Retrieve

Retrieve operation of resource: advertise-local-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-local-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

IMPORT - Update

Update operation of resource: import

import_schema

importbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Create

Create operation of resource: import

import_schema

importbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Delete

Delete operation of resource: import

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Retrieve

Retrieve operation of resource: import

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

import_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

DEFAULT-ORIGINATE - Update

Update operation of resource: default-originate

default-originate_schema

default-originatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Create

Create operation of resource: default-originate

default-originate_schema

default-originatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Delete

Delete operation of resource: default-originate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Retrieve

Retrieve operation of resource: default-originate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

default-originate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": "boolean",
  "route-policy-name": "string"
}

SOFT-RECONFIGURATION - Update

Update operation of resource: soft-reconfiguration

soft-reconfiguration_schema

soft-reconfigurationbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Create

Create operation of resource: soft-reconfiguration

soft-reconfiguration_schema

soft-reconfigurationbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Delete

Delete operation of resource: soft-reconfiguration

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Retrieve

Retrieve operation of resource: soft-reconfiguration

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

soft-reconfiguration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

ADVERTISE-VRF-IMP-DISABLE-V6 - Update

Update operation of resource: advertise-vrf-imp-disable-v6

advertise-vrf-imp-disable-v6_schema

advertise-vrf-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Create

Create operation of resource: advertise-vrf-imp-disable-v6

advertise-vrf-imp-disable-v6_schema

advertise-vrf-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Delete

Delete operation of resource: advertise-vrf-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Retrieve

Retrieve operation of resource: advertise-vrf-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-vrf-imp-disable-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-V4 - Update

Update operation of resource: advertise-v4

advertise-v4_schema

advertise-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Create

Create operation of resource: advertise-v4

advertise-v4_schema

advertise-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Delete

Delete operation of resource: advertise-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Retrieve

Retrieve operation of resource: advertise-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-V4 - Update

Update operation of resource: advertise-local-v4

advertise-local-v4_schema

advertise-local-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Create

Create operation of resource: advertise-local-v4

advertise-local-v4_schema

advertise-local-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Delete

Delete operation of resource: advertise-local-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Retrieve

Retrieve operation of resource: advertise-local-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-local-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Update

Update operation of resource: remove-private-as-entire-as-path

remove-private-as-entire-as-path_schema

remove-private-as-entire-as-pathbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Create

Create operation of resource: remove-private-as-entire-as-path

remove-private-as-entire-as-path_schema

remove-private-as-entire-as-pathbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Delete

Delete operation of resource: remove-private-as-entire-as-path

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Retrieve

Retrieve operation of resource: remove-private-as-entire-as-path

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

remove-private-as-entire-as-path_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "entire": "boolean",
  "enable": "boolean"
}

ADVERTISE-VRF-IMP-DISABLE-V4 - Update

Update operation of resource: advertise-vrf-imp-disable-v4

advertise-vrf-imp-disable-v4_schema

advertise-vrf-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Create

Create operation of resource: advertise-vrf-imp-disable-v4

advertise-vrf-imp-disable-v4_schema

advertise-vrf-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Delete

Delete operation of resource: advertise-vrf-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Retrieve

Retrieve operation of resource: advertise-vrf-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-vrf-imp-disable-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

LOCAL-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/local-address/

Update operation of resource: local-address

local-address_schema

local-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/local-address/

Create operation of resource: local-address

local-address_schema

local-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/local-address/

Delete operation of resource: local-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/local-address/

Retrieve operation of resource: local-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

local-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

BMP-ACTIVATES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/bmp-activates/

Update operation of resource: bmp-activates

bmp-activates_schema

bmp-activatesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/bmp-activates/

Create operation of resource: bmp-activates

bmp-activates_schema

bmp-activatesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/bmp-activates/

Delete operation of resource: bmp-activates

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/bmp-activates/

Retrieve operation of resource: bmp-activates

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

bmp-activates_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

BMP-ACTIVATE - Update

Update operation of resource: bmp-activate

bmp-activate_schema

bmp-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "server-id": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Create

Create operation of resource: bmp-activate

bmp-activate_schema

bmp-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "server-id": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Delete

Delete operation of resource: bmp-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

server-id

in path

string

ID of server-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Retrieve

Retrieve operation of resource: bmp-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

server-id

in path

string

ID of server-id

200 OK

bmp-activate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "server-id": "integer"
}

EBGP-MULTIHOP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/ebgp-multihop/

Update operation of resource: ebgp-multihop

ebgp-multihop_schema

ebgp-multihopbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/ebgp-multihop/

Create operation of resource: ebgp-multihop

ebgp-multihop_schema

ebgp-multihopbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/ebgp-multihop/

Delete operation of resource: ebgp-multihop

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/ebgp-multihop/

Retrieve operation of resource: ebgp-multihop

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

ebgp-multihop_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

REMOTE-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/remote-as/

Update operation of resource: remote-as

remote-as_schema

remote-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/remote-as/

Create operation of resource: remote-as

remote-as_schema

remote-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/remote-as/

Delete operation of resource: remote-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/remote-as/

Retrieve operation of resource: remote-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

remote-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-xx": "string",
  "as-yy": "string"
}

LOCAL-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/local-as/

Update operation of resource: local-as

local-as_schema

local-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/local-as/

Create operation of resource: local-as

local-as_schema

local-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/local-as/

Delete operation of resource: local-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/local-as/

Retrieve operation of resource: local-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

local-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

PASSWORD - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/password/

Update operation of resource: password

password_schema

passwordbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "password-disable": "boolean",
  "password": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/password/

Create operation of resource: password

password_schema

passwordbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "password-disable": "boolean",
  "password": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/password/

Delete operation of resource: password

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/password/

Retrieve operation of resource: password

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

password_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "password-disable": "boolean",
  "password": "string"
}

ADVERTISEMENT-INTERVAL - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/advertisement-interval/

Update operation of resource: advertisement-interval

advertisement-interval_schema

advertisement-intervalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/advertisement-interval/

Create operation of resource: advertisement-interval

advertisement-interval_schema

advertisement-intervalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/advertisement-interval/

Delete operation of resource: advertisement-interval

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/advertisement-interval/

Retrieve operation of resource: advertisement-interval

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

advertisement-interval_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

NEIGHBOR-CLUSTER-ID - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/neighbor-cluster-id/

Update operation of resource: neighbor-cluster-id

neighbor-cluster-id_schema

neighbor-cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/neighbor-cluster-id/

Create operation of resource: neighbor-cluster-id

neighbor-cluster-id_schema

neighbor-cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/neighbor-cluster-id/

Delete operation of resource: neighbor-cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/neighbor-cluster-id/

Retrieve operation of resource: neighbor-cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

neighbor-cluster-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

TCPMSS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/tcpmss/

Update operation of resource: tcpmss

tcpmss_schema

tcpmssbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/tcpmss/

Create operation of resource: tcpmss

tcpmss_schema

tcpmssbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/tcpmss/

Delete operation of resource: tcpmss

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/tcpmss/

Retrieve operation of resource: tcpmss

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

tcpmss_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

TOS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/tos/

Update operation of resource: tos

tos_schema

tosbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/tos/

Create operation of resource: tos

tos_schema

tosbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/tos/

Delete operation of resource: tos

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/tos/

Retrieve operation of resource: tos

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "type": "string",
  "value": "string"
}

UPDATE-IN-FILTERING - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/update-in-filtering/

Update operation of resource: update-in-filtering

update-in-filtering_schema

update-in-filteringbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/update-in-filtering/

Create operation of resource: update-in-filtering

update-in-filtering_schema

update-in-filteringbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/update-in-filtering/

Delete operation of resource: update-in-filtering

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/update-in-filtering/

Retrieve operation of resource: update-in-filtering

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

update-in-filtering_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Update

Update operation of resource: update-in-filtering-message-buffers

update-in-filtering-message-buffers_schema

update-in-filtering-message-buffersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Create

Create operation of resource: update-in-filtering-message-buffers

update-in-filtering-message-buffers_schema

update-in-filtering-message-buffersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Delete

Delete operation of resource: update-in-filtering-message-buffers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Retrieve

Retrieve operation of resource: update-in-filtering-message-buffers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

update-in-filtering-message-buffers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

MSG-LOG-OUT - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/msg-log-out/

Update operation of resource: msg-log-out

msg-log-out_schema

msg-log-outbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/msg-log-out/

Create operation of resource: msg-log-out

msg-log-out_schema

msg-log-outbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/msg-log-out/

Delete operation of resource: msg-log-out

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/msg-log-out/

Retrieve operation of resource: msg-log-out

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

msg-log-out_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

AO-KEYCHAIN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/ao-keychain/

Update operation of resource: ao-keychain

ao-keychain_schema

ao-keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/ao-keychain/

Create operation of resource: ao-keychain

ao-keychain_schema

ao-keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/ao-keychain/

Delete operation of resource: ao-keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/ao-keychain/

Retrieve operation of resource: ao-keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

ao-keychain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

RECEIVE-BUFFER-SIZE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/receive-buffer-size/

Update operation of resource: receive-buffer-size

receive-buffer-size_schema

receive-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/receive-buffer-size/

Create operation of resource: receive-buffer-size

receive-buffer-size_schema

receive-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/receive-buffer-size/

Delete operation of resource: receive-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/receive-buffer-size/

Retrieve operation of resource: receive-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

receive-buffer-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

MSG-LOG-IN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/msg-log-in/

Update operation of resource: msg-log-in

msg-log-in_schema

msg-log-inbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/msg-log-in/

Create operation of resource: msg-log-in

msg-log-in_schema

msg-log-inbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/msg-log-in/

Delete operation of resource: msg-log-in

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/msg-log-in/

Retrieve operation of resource: msg-log-in

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

msg-log-in_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

SEND-BUFFER-SIZE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/send-buffer-size/

Update operation of resource: send-buffer-size

send-buffer-size_schema

send-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/send-buffer-size/

Create operation of resource: send-buffer-size

send-buffer-size_schema

send-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/send-buffer-size/

Delete operation of resource: send-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/send-buffer-size/

Retrieve operation of resource: send-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

send-buffer-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

TIMERS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/timers/

Update operation of resource: timers

timers_schema

timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/timers/

Create operation of resource: timers

timers_schema

timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/timers/

Delete operation of resource: timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/timers/

Retrieve operation of resource: timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

timers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

KEYCHAIN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/keychain/

Update operation of resource: keychain

keychain_schema

keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/keychain/

Create operation of resource: keychain

keychain_schema

keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/keychain/

Delete operation of resource: keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/keychain/

Retrieve operation of resource: keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

keychain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

GRACEFUL-MAINTENANCE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/graceful-maintenance/

Update operation of resource: graceful-maintenance

graceful-maintenance_schema

graceful-maintenancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/graceful-maintenance/

Create operation of resource: graceful-maintenance

graceful-maintenance_schema

graceful-maintenancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/graceful-maintenance/

Delete operation of resource: graceful-maintenance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor/{neighbor-address}/graceful-maintenance/

Retrieve operation of resource: graceful-maintenance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

graceful-maintenance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Update

Update operation of resource: graceful-maintenance-local-preference

graceful-maintenance-local-preference_schema

graceful-maintenance-local-preferencebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Create

Create operation of resource: graceful-maintenance-local-preference

graceful-maintenance-local-preference_schema

graceful-maintenance-local-preferencebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Delete

Delete operation of resource: graceful-maintenance-local-preference

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Retrieve

Retrieve operation of resource: graceful-maintenance-local-preference

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

graceful-maintenance-local-preference_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

GRACEFUL-MAINTENANCE-AS-PREPENDS - Update

Update operation of resource: graceful-maintenance-as-prepends

graceful-maintenance-as-prepends_schema

graceful-maintenance-as-prependsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Create

Create operation of resource: graceful-maintenance-as-prepends

graceful-maintenance-as-prepends_schema

graceful-maintenance-as-prependsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Delete

Delete operation of resource: graceful-maintenance-as-prepends

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Retrieve

Retrieve operation of resource: graceful-maintenance-as-prepends

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

neighbor-address

in path

string

ID of neighbor-address

200 OK

graceful-maintenance-as-prepends_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

VRF-NEIGHBOR-PREFIX-LENGTH - Update

Update operation of resource: vrf-neighbor-prefix-length

vrf-neighbor-prefix-length_schema

vrf-neighbor-prefix-lengthbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "neighbor-address": "string",
  "prefix-length": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-PREFIX-LENGTH - Create

Create operation of resource: vrf-neighbor-prefix-length

vrf-neighbor-prefix-length_schema

vrf-neighbor-prefix-lengthbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "neighbor-address": "string",
  "prefix-length": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-PREFIX-LENGTH - Delete

Delete operation of resource: vrf-neighbor-prefix-length

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-PREFIX-LENGTH - Retrieve

Retrieve operation of resource: vrf-neighbor-prefix-length

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

vrf-neighbor-prefix-length_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "neighbor-address": "string",
  "prefix-length": "integer"
}

VRF-NEIGHBOR-AFS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/

Update operation of resource: vrf-neighbor-afs

vrf-neighbor-afs_schema

vrf-neighbor-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "vrf-neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-AFS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/

Create operation of resource: vrf-neighbor-afs

vrf-neighbor-afs_schema

vrf-neighbor-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "vrf-neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-AFS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/

Delete operation of resource: vrf-neighbor-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-AFS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/

Retrieve operation of resource: vrf-neighbor-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

vrf-neighbor-afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "vrf-neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

VRF-NEIGHBOR-AF - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/

Update operation of resource: vrf-neighbor-af

ADVERTISE-VRF-IMP-DISABLE-V4

vrf-neighbor-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-AF - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/

Create operation of resource: vrf-neighbor-af

ADVERTISE-VRF-IMP-DISABLE-V4

vrf-neighbor-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-AF - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/

Delete operation of resource: vrf-neighbor-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NEIGHBOR-AF - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/

Retrieve operation of resource: vrf-neighbor-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

ADVERTISE-VRF-IMP-DISABLE-V4

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

AIGP-COST-COMMUNITY - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/aigp-cost-community/

Update operation of resource: aigp-cost-community

aigp-cost-community_schema

aigp-cost-communitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/aigp-cost-community/

Create operation of resource: aigp-cost-community

aigp-cost-community_schema

aigp-cost-communitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/aigp-cost-community/

Delete operation of resource: aigp-cost-community

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/aigp-cost-community/

Retrieve operation of resource: aigp-cost-community

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

aigp-cost-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

ADVERTISE-DEF-IMP-DISABLE-V6 - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-def-imp-disable-v6/

Update operation of resource: advertise-def-imp-disable-v6

advertise-def-imp-disable-v6_schema

advertise-def-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-def-imp-disable-v6/

Create operation of resource: advertise-def-imp-disable-v6

advertise-def-imp-disable-v6_schema

advertise-def-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-def-imp-disable-v6/

Delete operation of resource: advertise-def-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-def-imp-disable-v6/

Retrieve operation of resource: advertise-def-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-def-imp-disable-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-DISABLE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-disable/

Update operation of resource: advertise-disable

advertise-disable_schema

advertise-disablebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-disable/

Create operation of resource: advertise-disable

advertise-disable_schema

advertise-disablebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-disable/

Delete operation of resource: advertise-disable

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-disable/

Retrieve operation of resource: advertise-disable

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-disable_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

MAXIMUM-PREFIXES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/maximum-prefixes/

Update operation of resource: maximum-prefixes

maximum-prefixes_schema

maximum-prefixesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/maximum-prefixes/

Create operation of resource: maximum-prefixes

maximum-prefixes_schema

maximum-prefixesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/maximum-prefixes/

Delete operation of resource: maximum-prefixes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/maximum-prefixes/

Retrieve operation of resource: maximum-prefixes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

maximum-prefixes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/remove-private-as-entire-as-path-inbound/

Update operation of resource: remove-private-as-entire-as-path-inbound

remove-private-as-entire-as-path-inbound_schema

remove-private-as-entire-as-path-inboundbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/remove-private-as-entire-as-path-inbound/

Create operation of resource: remove-private-as-entire-as-path-inbound

remove-private-as-entire-as-path-inbound_schema

remove-private-as-entire-as-path-inboundbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/remove-private-as-entire-as-path-inbound/

Delete operation of resource: remove-private-as-entire-as-path-inbound

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/remove-private-as-entire-as-path-inbound/

Retrieve operation of resource: remove-private-as-entire-as-path-inbound

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

remove-private-as-entire-as-path-inbound_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "entire": "boolean",
  "enable": "boolean"
}

ADVERTISE-DEF-IMP-DISABLE-V4 - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-def-imp-disable-v4/

Update operation of resource: advertise-def-imp-disable-v4

advertise-def-imp-disable-v4_schema

advertise-def-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-def-imp-disable-v4/

Create operation of resource: advertise-def-imp-disable-v4

advertise-def-imp-disable-v4_schema

advertise-def-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-def-imp-disable-v4/

Delete operation of resource: advertise-def-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-def-imp-disable-v4/

Retrieve operation of resource: advertise-def-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-def-imp-disable-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-L2VPN-EVPN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-l2vpn-evpn/

Update operation of resource: advertise-l2vpn-evpn

advertise-l2vpn-evpn_schema

advertise-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-l2vpn-evpn/

Create operation of resource: advertise-l2vpn-evpn

advertise-l2vpn-evpn_schema

advertise-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-l2vpn-evpn/

Delete operation of resource: advertise-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-l2vpn-evpn/

Retrieve operation of resource: advertise-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-l2vpn-evpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-L2VPN-EVPN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-local-l2vpn-evpn/

Update operation of resource: advertise-local-l2vpn-evpn

advertise-local-l2vpn-evpn_schema

advertise-local-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-local-l2vpn-evpn/

Create operation of resource: advertise-local-l2vpn-evpn

advertise-local-l2vpn-evpn_schema

advertise-local-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-local-l2vpn-evpn/

Delete operation of resource: advertise-local-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-local-l2vpn-evpn/

Retrieve operation of resource: advertise-local-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-local-l2vpn-evpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/neighbor-af-long-lived-graceful-restart-stale-time/

Update operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

neighbor-af-long-lived-graceful-restart-stale-time_schema

neighbor-af-long-lived-graceful-restart-stale-timebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/neighbor-af-long-lived-graceful-restart-stale-time/

Create operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

neighbor-af-long-lived-graceful-restart-stale-time_schema

neighbor-af-long-lived-graceful-restart-stale-timebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/neighbor-af-long-lived-graceful-restart-stale-time/

Delete operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/neighbor-af-long-lived-graceful-restart-stale-time/

Retrieve operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

neighbor-af-long-lived-graceful-restart-stale-time_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

SITE-OF-ORIGIN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/site-of-origin/

Update operation of resource: site-of-origin

site-of-origin_schema

site-of-originbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SITE-OF-ORIGIN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/site-of-origin/

Create operation of resource: site-of-origin

site-of-origin_schema

site-of-originbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SITE-OF-ORIGIN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/site-of-origin/

Delete operation of resource: site-of-origin

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SITE-OF-ORIGIN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/site-of-origin/

Retrieve operation of resource: site-of-origin

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

site-of-origin_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

ADVERTISE-V6 - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-v6/

Update operation of resource: advertise-v6

advertise-v6_schema

advertise-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-v6/

Create operation of resource: advertise-v6

advertise-v6_schema

advertise-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-v6/

Delete operation of resource: advertise-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-v6/

Retrieve operation of resource: advertise-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-V6 - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-local-v6/

Update operation of resource: advertise-local-v6

advertise-local-v6_schema

advertise-local-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-local-v6/

Create operation of resource: advertise-local-v6

advertise-local-v6_schema

advertise-local-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-local-v6/

Delete operation of resource: advertise-local-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-local-v6/

Retrieve operation of resource: advertise-local-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-local-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

IMPORT - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/import/

Update operation of resource: import

import_schema

importbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/import/

Create operation of resource: import

import_schema

importbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/import/

Delete operation of resource: import

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/import/

Retrieve operation of resource: import

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

import_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

DEFAULT-ORIGINATE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/default-originate/

Update operation of resource: default-originate

default-originate_schema

default-originatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/default-originate/

Create operation of resource: default-originate

default-originate_schema

default-originatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/default-originate/

Delete operation of resource: default-originate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/default-originate/

Retrieve operation of resource: default-originate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

default-originate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": "boolean",
  "route-policy-name": "string"
}

SOFT-RECONFIGURATION - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/soft-reconfiguration/

Update operation of resource: soft-reconfiguration

soft-reconfiguration_schema

soft-reconfigurationbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/soft-reconfiguration/

Create operation of resource: soft-reconfiguration

soft-reconfiguration_schema

soft-reconfigurationbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/soft-reconfiguration/

Delete operation of resource: soft-reconfiguration

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/soft-reconfiguration/

Retrieve operation of resource: soft-reconfiguration

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

soft-reconfiguration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

ADVERTISE-VRF-IMP-DISABLE-V6 - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-vrf-imp-disable-v6/

Update operation of resource: advertise-vrf-imp-disable-v6

advertise-vrf-imp-disable-v6_schema

advertise-vrf-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-vrf-imp-disable-v6/

Create operation of resource: advertise-vrf-imp-disable-v6

advertise-vrf-imp-disable-v6_schema

advertise-vrf-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-vrf-imp-disable-v6/

Delete operation of resource: advertise-vrf-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-vrf-imp-disable-v6/

Retrieve operation of resource: advertise-vrf-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-vrf-imp-disable-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-V4 - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-v4/

Update operation of resource: advertise-v4

advertise-v4_schema

advertise-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-v4/

Create operation of resource: advertise-v4

advertise-v4_schema

advertise-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-v4/

Delete operation of resource: advertise-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-v4/

Retrieve operation of resource: advertise-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-V4 - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-local-v4/

Update operation of resource: advertise-local-v4

advertise-local-v4_schema

advertise-local-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-local-v4/

Create operation of resource: advertise-local-v4

advertise-local-v4_schema

advertise-local-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-local-v4/

Delete operation of resource: advertise-local-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-local-v4/

Retrieve operation of resource: advertise-local-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-local-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/remove-private-as-entire-as-path/

Update operation of resource: remove-private-as-entire-as-path

remove-private-as-entire-as-path_schema

remove-private-as-entire-as-pathbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/remove-private-as-entire-as-path/

Create operation of resource: remove-private-as-entire-as-path

remove-private-as-entire-as-path_schema

remove-private-as-entire-as-pathbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/remove-private-as-entire-as-path/

Delete operation of resource: remove-private-as-entire-as-path

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/remove-private-as-entire-as-path/

Retrieve operation of resource: remove-private-as-entire-as-path

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

remove-private-as-entire-as-path_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "entire": "boolean",
  "enable": "boolean"
}

ADVERTISE-VRF-IMP-DISABLE-V4 - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-vrf-imp-disable-v4/

Update operation of resource: advertise-vrf-imp-disable-v4

advertise-vrf-imp-disable-v4_schema

advertise-vrf-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-vrf-imp-disable-v4/

Create operation of resource: advertise-vrf-imp-disable-v4

advertise-vrf-imp-disable-v4_schema

advertise-vrf-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-vrf-imp-disable-v4/

Delete operation of resource: advertise-vrf-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/vrf-neighbor-afs/vrf-neighbor-af/{af-name}/advertise-vrf-imp-disable-v4/

Retrieve operation of resource: advertise-vrf-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-vrf-imp-disable-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

LOCAL-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/local-address/

Update operation of resource: local-address

local-address_schema

local-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/local-address/

Create operation of resource: local-address

local-address_schema

local-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/local-address/

Delete operation of resource: local-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/local-address/

Retrieve operation of resource: local-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

local-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

BMP-ACTIVATES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/bmp-activates/

Update operation of resource: bmp-activates

bmp-activates_schema

bmp-activatesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/bmp-activates/

Create operation of resource: bmp-activates

bmp-activates_schema

bmp-activatesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/bmp-activates/

Delete operation of resource: bmp-activates

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/bmp-activates/

Retrieve operation of resource: bmp-activates

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

bmp-activates_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

BMP-ACTIVATE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/bmp-activates/bmp-activate/{server-id}/

Update operation of resource: bmp-activate

bmp-activate_schema

bmp-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "server-id": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/bmp-activates/bmp-activate/{server-id}/

Create operation of resource: bmp-activate

bmp-activate_schema

bmp-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "server-id": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/bmp-activates/bmp-activate/{server-id}/

Delete operation of resource: bmp-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

server-id

in path

string

ID of server-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/bmp-activates/bmp-activate/{server-id}/

Retrieve operation of resource: bmp-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

server-id

in path

string

ID of server-id

200 OK

bmp-activate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "server-id": "integer"
}

EBGP-MULTIHOP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/ebgp-multihop/

Update operation of resource: ebgp-multihop

ebgp-multihop_schema

ebgp-multihopbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/ebgp-multihop/

Create operation of resource: ebgp-multihop

ebgp-multihop_schema

ebgp-multihopbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/ebgp-multihop/

Delete operation of resource: ebgp-multihop

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/ebgp-multihop/

Retrieve operation of resource: ebgp-multihop

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

ebgp-multihop_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

REMOTE-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/remote-as/

Update operation of resource: remote-as

remote-as_schema

remote-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/remote-as/

Create operation of resource: remote-as

remote-as_schema

remote-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/remote-as/

Delete operation of resource: remote-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/remote-as/

Retrieve operation of resource: remote-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

remote-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-xx": "string",
  "as-yy": "string"
}

LOCAL-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/local-as/

Update operation of resource: local-as

local-as_schema

local-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/local-as/

Create operation of resource: local-as

local-as_schema

local-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/local-as/

Delete operation of resource: local-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/local-as/

Retrieve operation of resource: local-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

local-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

PASSWORD - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/password/

Update operation of resource: password

password_schema

passwordbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "password-disable": "boolean",
  "password": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/password/

Create operation of resource: password

password_schema

passwordbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "password-disable": "boolean",
  "password": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/password/

Delete operation of resource: password

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/password/

Retrieve operation of resource: password

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

password_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "password-disable": "boolean",
  "password": "string"
}

ADVERTISEMENT-INTERVAL - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/advertisement-interval/

Update operation of resource: advertisement-interval

advertisement-interval_schema

advertisement-intervalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/advertisement-interval/

Create operation of resource: advertisement-interval

advertisement-interval_schema

advertisement-intervalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/advertisement-interval/

Delete operation of resource: advertisement-interval

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/advertisement-interval/

Retrieve operation of resource: advertisement-interval

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

advertisement-interval_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

NEIGHBOR-CLUSTER-ID - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/neighbor-cluster-id/

Update operation of resource: neighbor-cluster-id

neighbor-cluster-id_schema

neighbor-cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/neighbor-cluster-id/

Create operation of resource: neighbor-cluster-id

neighbor-cluster-id_schema

neighbor-cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/neighbor-cluster-id/

Delete operation of resource: neighbor-cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/neighbor-cluster-id/

Retrieve operation of resource: neighbor-cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

neighbor-cluster-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

TCPMSS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/tcpmss/

Update operation of resource: tcpmss

tcpmss_schema

tcpmssbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/tcpmss/

Create operation of resource: tcpmss

tcpmss_schema

tcpmssbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/tcpmss/

Delete operation of resource: tcpmss

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/tcpmss/

Retrieve operation of resource: tcpmss

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

tcpmss_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

TOS - Update

Update operation of resource: tos

tos_schema

tosbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

Create operation of resource: tos

tos_schema

tosbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

Delete operation of resource: tos

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

Retrieve operation of resource: tos

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "type": "string",
  "value": "string"
}

UPDATE-IN-FILTERING - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/update-in-filtering/

Update operation of resource: update-in-filtering

update-in-filtering_schema

update-in-filteringbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/update-in-filtering/

Create operation of resource: update-in-filtering

update-in-filtering_schema

update-in-filteringbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/update-in-filtering/

Delete operation of resource: update-in-filtering

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/update-in-filtering/

Retrieve operation of resource: update-in-filtering

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

update-in-filtering_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/update-in-filtering/update-in-filtering-message-buffers/

Update operation of resource: update-in-filtering-message-buffers

update-in-filtering-message-buffers_schema

update-in-filtering-message-buffersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/update-in-filtering/update-in-filtering-message-buffers/

Create operation of resource: update-in-filtering-message-buffers

update-in-filtering-message-buffers_schema

update-in-filtering-message-buffersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/update-in-filtering/update-in-filtering-message-buffers/

Delete operation of resource: update-in-filtering-message-buffers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/update-in-filtering/update-in-filtering-message-buffers/

Retrieve operation of resource: update-in-filtering-message-buffers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

update-in-filtering-message-buffers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

MSG-LOG-OUT - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/msg-log-out/

Update operation of resource: msg-log-out

msg-log-out_schema

msg-log-outbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/msg-log-out/

Create operation of resource: msg-log-out

msg-log-out_schema

msg-log-outbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/msg-log-out/

Delete operation of resource: msg-log-out

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/msg-log-out/

Retrieve operation of resource: msg-log-out

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

msg-log-out_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

AO-KEYCHAIN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/ao-keychain/

Update operation of resource: ao-keychain

ao-keychain_schema

ao-keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/ao-keychain/

Create operation of resource: ao-keychain

ao-keychain_schema

ao-keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/ao-keychain/

Delete operation of resource: ao-keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/ao-keychain/

Retrieve operation of resource: ao-keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

ao-keychain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

RECEIVE-BUFFER-SIZE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/receive-buffer-size/

Update operation of resource: receive-buffer-size

receive-buffer-size_schema

receive-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/receive-buffer-size/

Create operation of resource: receive-buffer-size

receive-buffer-size_schema

receive-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/receive-buffer-size/

Delete operation of resource: receive-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/receive-buffer-size/

Retrieve operation of resource: receive-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

receive-buffer-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

MSG-LOG-IN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/msg-log-in/

Update operation of resource: msg-log-in

msg-log-in_schema

msg-log-inbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/msg-log-in/

Create operation of resource: msg-log-in

msg-log-in_schema

msg-log-inbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/msg-log-in/

Delete operation of resource: msg-log-in

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/msg-log-in/

Retrieve operation of resource: msg-log-in

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

msg-log-in_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

SEND-BUFFER-SIZE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/send-buffer-size/

Update operation of resource: send-buffer-size

send-buffer-size_schema

send-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/send-buffer-size/

Create operation of resource: send-buffer-size

send-buffer-size_schema

send-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/send-buffer-size/

Delete operation of resource: send-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/send-buffer-size/

Retrieve operation of resource: send-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

send-buffer-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

TIMERS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/timers/

Update operation of resource: timers

timers_schema

timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/timers/

Create operation of resource: timers

timers_schema

timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/timers/

Delete operation of resource: timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/timers/

Retrieve operation of resource: timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

timers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

KEYCHAIN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/keychain/

Update operation of resource: keychain

keychain_schema

keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/keychain/

Create operation of resource: keychain

keychain_schema

keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/keychain/

Delete operation of resource: keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/keychain/

Retrieve operation of resource: keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

keychain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

GRACEFUL-MAINTENANCE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/graceful-maintenance/

Update operation of resource: graceful-maintenance

graceful-maintenance_schema

graceful-maintenancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/graceful-maintenance/

Create operation of resource: graceful-maintenance

graceful-maintenance_schema

graceful-maintenancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/graceful-maintenance/

Delete operation of resource: graceful-maintenance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/graceful-maintenance/

Retrieve operation of resource: graceful-maintenance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

graceful-maintenance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/graceful-maintenance/graceful-maintenance-local-preference/

Update operation of resource: graceful-maintenance-local-preference

graceful-maintenance-local-preference_schema

graceful-maintenance-local-preferencebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/graceful-maintenance/graceful-maintenance-local-preference/

Create operation of resource: graceful-maintenance-local-preference

graceful-maintenance-local-preference_schema

graceful-maintenance-local-preferencebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/graceful-maintenance/graceful-maintenance-local-preference/

Delete operation of resource: graceful-maintenance-local-preference

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/graceful-maintenance/graceful-maintenance-local-preference/

Retrieve operation of resource: graceful-maintenance-local-preference

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

graceful-maintenance-local-preference_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

GRACEFUL-MAINTENANCE-AS-PREPENDS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/graceful-maintenance/graceful-maintenance-as-prepends/

Update operation of resource: graceful-maintenance-as-prepends

graceful-maintenance-as-prepends_schema

graceful-maintenance-as-prependsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/graceful-maintenance/graceful-maintenance-as-prepends/

Create operation of resource: graceful-maintenance-as-prepends

graceful-maintenance-as-prepends_schema

graceful-maintenance-as-prependsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/graceful-maintenance/graceful-maintenance-as-prepends/

Delete operation of resource: graceful-maintenance-as-prepends

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-neighbors/vrf-neighbor-prefix-length/{prefix-length neighbor-address}/graceful-maintenance/graceful-maintenance-as-prepends/

Retrieve operation of resource: graceful-maintenance-as-prepends

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

vrf-name

in path

string

ID of vrf-name

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

graceful-maintenance-as-prepends_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

DEFAULT-VRF - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/

Update operation of resource: default-vrf

default-vrf_schema

default-vrfbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "global": {
    "mvpn": [ null ],
    "rpki-origin-as-validation-disable": [ null ],
    "rpki-static-routes": {
      "rpki-static-route": [
        {
          "addrress": "string",
          "as": "integer",
          "minimum": "integer",
          "maximum": "integer"
        }
      ]
    },
    "update-error-handling-extended-ibgp": [ null ],
    "install-diversion": [ null ],
    "attribute-filter-groups": {
      "attribute-filter-group": [
        {
          "enable": [ null ],
          "attribute-filter-group-name": "string",
          "attribute-filters": {
            "attribute-filter": [
              {
                "attribute-start": "string",
                "attribute-end": "string",
                "filter-action": "string"
              }
            ]
          }
        }
      ]
    },
    "update-limit-process": "integer",
    "rpki-origin-as-validation-time": "integer",
    "nsr": "boolean",
    "read-only": [ null ],
    "graceful-restart-stalepath-time": "integer",
    "graceful-reset": [ null ],
    "update-out-logging": [ null ],
    "graceful-restart-time": "integer",
    "confederation-domain": {
      "as-xx": "string",
      "as-yy": "string"
    },
    "global-graceful-maintenance-activate": {
      "retain-routes": "boolean",
      "all-neighbors": "boolean"
    },
    "graceful-restart-purge-time": "integer",
    "confederation-peer-ases": {
      "confederation-peer-as": [
        {
          "as-xx": "string",
          "as-yy": "string"
        }
      ]
    },
    "update-error-handling-basic-ebgp-disable": [ null ],
    "igp-loop-check": [ null ],
    "write-limit": {
      "formatted-messages": "integer",
      "desynchronize": "boolean",
      "enqueued-messages": "integer"
    },
    "rpki-bestpath-use-origin-as-validity": [ null ],
    "cluster-id": {
      "cluster-id-number": "integer",
      "cluster-id-address": "string"
    },
    "as-league": {
      "peers": {
        "peer": [
          {
            "as-xx": "string",
            "as-yy": "string"
          }
        ]
      },
      "enable": [ null ]
    },
    "enforce-ibgp-out-policy": [ null ],
    "rpki-servers": {
      "rpki-server": [
        {
          "username": "string",
          "password": "string",
          "enable": [ null ],
          "response-time": "integer",
          "refresh-time": "integer",
          "server": "string",
          "shutdown": [ null ],
          "purge-time": "integer",
          "transport": {
            "port": "string",
            "transport": "string"
          }
        }
      ]
    },
    "update-delay": {
      "delay": "integer",
      "always": "boolean"
    },
    "update-error-handling-basic-ibgp-disable": [ null ],
    "next-hop-trigger-delay": "integer",
    "as-list-groups": {
      "as-list-group": [
        {
          "ases": {
            "as": [
              {
                "as-xx": "string",
                "as-yy": "string"
              }
            ]
          },
          "enable": [ null ],
          "as-list-group-name": "string"
        }
      ]
    },
    "limits": {
      "maximum-neighbors": "integer"
    },
    "rpki-bestpath-origin-as-allow-invalid": [ null ],
    "global-afs": {},
    "local-preference": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-VRF - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/

Create operation of resource: default-vrf

default-vrf_schema

default-vrfbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "global": {
    "mvpn": [ null ],
    "rpki-origin-as-validation-disable": [ null ],
    "rpki-static-routes": {
      "rpki-static-route": [
        {
          "addrress": "string",
          "as": "integer",
          "minimum": "integer",
          "maximum": "integer"
        }
      ]
    },
    "update-error-handling-extended-ibgp": [ null ],
    "install-diversion": [ null ],
    "attribute-filter-groups": {
      "attribute-filter-group": [
        {
          "enable": [ null ],
          "attribute-filter-group-name": "string",
          "attribute-filters": {
            "attribute-filter": [
              {
                "attribute-start": "string",
                "attribute-end": "string",
                "filter-action": "string"
              }
            ]
          }
        }
      ]
    },
    "update-limit-process": "integer",
    "rpki-origin-as-validation-time": "integer",
    "nsr": "boolean",
    "read-only": [ null ],
    "graceful-restart-stalepath-time": "integer",
    "graceful-reset": [ null ],
    "update-out-logging": [ null ],
    "graceful-restart-time": "integer",
    "confederation-domain": {
      "as-xx": "string",
      "as-yy": "string"
    },
    "global-graceful-maintenance-activate": {
      "retain-routes": "boolean",
      "all-neighbors": "boolean"
    },
    "graceful-restart-purge-time": "integer",
    "confederation-peer-ases": {
      "confederation-peer-as": [
        {
          "as-xx": "string",
          "as-yy": "string"
        }
      ]
    },
    "update-error-handling-basic-ebgp-disable": [ null ],
    "igp-loop-check": [ null ],
    "write-limit": {
      "formatted-messages": "integer",
      "desynchronize": "boolean",
      "enqueued-messages": "integer"
    },
    "rpki-bestpath-use-origin-as-validity": [ null ],
    "cluster-id": {
      "cluster-id-number": "integer",
      "cluster-id-address": "string"
    },
    "as-league": {
      "peers": {
        "peer": [
          {
            "as-xx": "string",
            "as-yy": "string"
          }
        ]
      },
      "enable": [ null ]
    },
    "enforce-ibgp-out-policy": [ null ],
    "rpki-servers": {
      "rpki-server": [
        {
          "username": "string",
          "password": "string",
          "enable": [ null ],
          "response-time": "integer",
          "refresh-time": "integer",
          "server": "string",
          "shutdown": [ null ],
          "purge-time": "integer",
          "transport": {
            "port": "string",
            "transport": "string"
          }
        }
      ]
    },
    "update-delay": {
      "delay": "integer",
      "always": "boolean"
    },
    "update-error-handling-basic-ibgp-disable": [ null ],
    "next-hop-trigger-delay": "integer",
    "as-list-groups": {
      "as-list-group": [
        {
          "ases": {
            "as": [
              {
                "as-xx": "string",
                "as-yy": "string"
              }
            ]
          },
          "enable": [ null ],
          "as-list-group-name": "string"
        }
      ]
    },
    "limits": {
      "maximum-neighbors": "integer"
    },
    "rpki-bestpath-origin-as-allow-invalid": [ null ],
    "global-afs": {},
    "local-preference": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-VRF - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/

Delete operation of resource: default-vrf

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-VRF - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/

Retrieve operation of resource: default-vrf

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

default-vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "global": {
    "mvpn": [ null ],
    "rpki-origin-as-validation-disable": [ null ],
    "rpki-static-routes": {
      "rpki-static-route": [
        {
          "addrress": "string",
          "as": "integer",
          "minimum": "integer",
          "maximum": "integer"
        }
      ]
    },
    "update-error-handling-extended-ibgp": [ null ],
    "install-diversion": [ null ],
    "attribute-filter-groups": {
      "attribute-filter-group": [
        {
          "enable": [ null ],
          "attribute-filter-group-name": "string",
          "attribute-filters": {
            "attribute-filter": [
              {
                "attribute-start": "string",
                "attribute-end": "string",
                "filter-action": "string"
              }
            ]
          }
        }
      ]
    },
    "update-limit-process": "integer",
    "rpki-origin-as-validation-time": "integer",
    "nsr": "boolean",
    "read-only": [ null ],
    "graceful-restart-stalepath-time": "integer",
    "graceful-reset": [ null ],
    "update-out-logging": [ null ],
    "graceful-restart-time": "integer",
    "confederation-domain": {
      "as-xx": "string",
      "as-yy": "string"
    },
    "global-graceful-maintenance-activate": {
      "retain-routes": "boolean",
      "all-neighbors": "boolean"
    },
    "graceful-restart-purge-time": "integer",
    "confederation-peer-ases": {
      "confederation-peer-as": [
        {
          "as-xx": "string",
          "as-yy": "string"
        }
      ]
    },
    "update-error-handling-basic-ebgp-disable": [ null ],
    "igp-loop-check": [ null ],
    "write-limit": {
      "formatted-messages": "integer",
      "desynchronize": "boolean",
      "enqueued-messages": "integer"
    },
    "rpki-bestpath-use-origin-as-validity": [ null ],
    "cluster-id": {
      "cluster-id-number": "integer",
      "cluster-id-address": "string"
    },
    "as-league": {
      "peers": {
        "peer": [
          {
            "as-xx": "string",
            "as-yy": "string"
          }
        ]
      },
      "enable": [ null ]
    },
    "enforce-ibgp-out-policy": [ null ],
    "rpki-servers": {
      "rpki-server": [
        {
          "username": "string",
          "password": "string",
          "enable": [ null ],
          "response-time": "integer",
          "refresh-time": "integer",
          "server": "string",
          "shutdown": [ null ],
          "purge-time": "integer",
          "transport": {
            "port": "string",
            "transport": "string"
          }
        }
      ]
    },
    "update-delay": {
      "delay": "integer",
      "always": "boolean"
    },
    "update-error-handling-basic-ibgp-disable": [ null ],
    "next-hop-trigger-delay": "integer",
    "as-list-groups": {
      "as-list-group": [
        {
          "ases": {
            "as": [
              {
                "as-xx": "string",
                "as-yy": "string"
              }
            ]
          },
          "enable": [ null ],
          "as-list-group-name": "string"
        }
      ]
    },
    "limits": {
      "maximum-neighbors": "integer"
    },
    "rpki-bestpath-origin-as-allow-invalid": [ null ],
    "global-afs": {},
    "local-preference": "integer"
  }
}

BGP-ENTITY - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/

Update operation of resource: bgp-entity

bgp-entity_schema

bgp-entitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "neighbors": {
    "neighbor-prefix-length": [
      {
        "neighbor-address": "string",
        "prefix-length": "integer"
      }
    ],
    "neighbor": [
      {
        "neighbor-address": "string"
      }
    ]
  },
  "neighbor-groups": {
    "neighbor-group": [
      {
        "neighbor-group-afs": {
          "neighbor-group-af": [
            {
              "af-name": "string",
              "advertise-vrf-imp-disable-v4": {
                "af-name": "string",
                "rt-type": "string",
                "adv-option": "string"
              }
            }
          ]
        },
        "neighbor-group-name": "string",
        "neighbor-group-add-member": "string",
        "graceful-maintenance": {
          "enable": [ null ],
          "graceful-maintenance-local-preference": {
            "local-preference": "integer",
            "gshut-loc-pref-disable": "boolean"
          },
          "graceful-maintenance-activate": "boolean",
          "graceful-maintenance-as-prepends": {
            "gshut-prepends-disable": "boolean",
            "as-prepends": "integer"
          }
        }
      }
    ]
  },
  "af-groups": {
    "af-group": [
      {
        "af-group-name": "string",
        "af-group-afs": {
          "af-group-af": [
            {
              "af-name": "string",
              "create": [ null ],
              "af-group": "string",
              "advertise-vrf-imp-disable-v4": {
                "af-name": "string",
                "rt-type": "string",
                "adv-option": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "session-groups": {
    "session-group": [
      {
        "session-group-name": "string",
        "session-group-add-member": "string",
        "graceful-maintenance": {
          "enable": [ null ],
          "graceful-maintenance-local-preference": {
            "local-preference": "integer",
            "gshut-loc-pref-disable": "boolean"
          },
          "graceful-maintenance-activate": "boolean",
          "graceful-maintenance-as-prepends": {
            "gshut-prepends-disable": "boolean",
            "as-prepends": "integer"
          }
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BGP-ENTITY - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/

Create operation of resource: bgp-entity

bgp-entity_schema

bgp-entitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "neighbors": {
    "neighbor-prefix-length": [
      {
        "neighbor-address": "string",
        "prefix-length": "integer"
      }
    ],
    "neighbor": [
      {
        "neighbor-address": "string"
      }
    ]
  },
  "neighbor-groups": {
    "neighbor-group": [
      {
        "neighbor-group-afs": {
          "neighbor-group-af": [
            {
              "af-name": "string",
              "advertise-vrf-imp-disable-v4": {
                "af-name": "string",
                "rt-type": "string",
                "adv-option": "string"
              }
            }
          ]
        },
        "neighbor-group-name": "string",
        "neighbor-group-add-member": "string",
        "graceful-maintenance": {
          "enable": [ null ],
          "graceful-maintenance-local-preference": {
            "local-preference": "integer",
            "gshut-loc-pref-disable": "boolean"
          },
          "graceful-maintenance-activate": "boolean",
          "graceful-maintenance-as-prepends": {
            "gshut-prepends-disable": "boolean",
            "as-prepends": "integer"
          }
        }
      }
    ]
  },
  "af-groups": {
    "af-group": [
      {
        "af-group-name": "string",
        "af-group-afs": {
          "af-group-af": [
            {
              "af-name": "string",
              "create": [ null ],
              "af-group": "string",
              "advertise-vrf-imp-disable-v4": {
                "af-name": "string",
                "rt-type": "string",
                "adv-option": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "session-groups": {
    "session-group": [
      {
        "session-group-name": "string",
        "session-group-add-member": "string",
        "graceful-maintenance": {
          "enable": [ null ],
          "graceful-maintenance-local-preference": {
            "local-preference": "integer",
            "gshut-loc-pref-disable": "boolean"
          },
          "graceful-maintenance-activate": "boolean",
          "graceful-maintenance-as-prepends": {
            "gshut-prepends-disable": "boolean",
            "as-prepends": "integer"
          }
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BGP-ENTITY - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/

Delete operation of resource: bgp-entity

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BGP-ENTITY - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/

Retrieve operation of resource: bgp-entity

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

bgp-entity_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "neighbors": {
    "neighbor-prefix-length": [
      {
        "neighbor-address": "string",
        "prefix-length": "integer"
      }
    ],
    "neighbor": [
      {
        "neighbor-address": "string"
      }
    ]
  },
  "neighbor-groups": {
    "neighbor-group": [
      {
        "neighbor-group-afs": {
          "neighbor-group-af": [
            {
              "af-name": "string",
              "advertise-vrf-imp-disable-v4": {
                "af-name": "string",
                "rt-type": "string",
                "adv-option": "string"
              }
            }
          ]
        },
        "neighbor-group-name": "string",
        "neighbor-group-add-member": "string",
        "graceful-maintenance": {
          "enable": [ null ],
          "graceful-maintenance-local-preference": {
            "local-preference": "integer",
            "gshut-loc-pref-disable": "boolean"
          },
          "graceful-maintenance-activate": "boolean",
          "graceful-maintenance-as-prepends": {
            "gshut-prepends-disable": "boolean",
            "as-prepends": "integer"
          }
        }
      }
    ]
  },
  "af-groups": {
    "af-group": [
      {
        "af-group-name": "string",
        "af-group-afs": {
          "af-group-af": [
            {
              "af-name": "string",
              "create": [ null ],
              "af-group": "string",
              "advertise-vrf-imp-disable-v4": {
                "af-name": "string",
                "rt-type": "string",
                "adv-option": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "session-groups": {
    "session-group": [
      {
        "session-group-name": "string",
        "session-group-add-member": "string",
        "graceful-maintenance": {
          "enable": [ null ],
          "graceful-maintenance-local-preference": {
            "local-preference": "integer",
            "gshut-loc-pref-disable": "boolean"
          },
          "graceful-maintenance-activate": "boolean",
          "graceful-maintenance-as-prepends": {
            "gshut-prepends-disable": "boolean",
            "as-prepends": "integer"
          }
        }
      }
    ]
  }
}

NEIGHBORS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/

Update operation of resource: neighbors

neighbors_schema

neighborsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "neighbor-prefix-length": [
    {
      "neighbor-address": "string",
      "prefix-length": "integer"
    }
  ],
  "neighbor": [
    {
      "neighbor-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBORS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/

Create operation of resource: neighbors

neighbors_schema

neighborsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "neighbor-prefix-length": [
    {
      "neighbor-address": "string",
      "prefix-length": "integer"
    }
  ],
  "neighbor": [
    {
      "neighbor-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBORS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/

Delete operation of resource: neighbors

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBORS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/

Retrieve operation of resource: neighbors

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

neighbors_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "neighbor-prefix-length": [
    {
      "neighbor-address": "string",
      "prefix-length": "integer"
    }
  ],
  "neighbor": [
    {
      "neighbor-address": "string"
    }
  ]
}

NEIGHBOR - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/

Update operation of resource: neighbor

neighbor_schema

neighborbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "neighbor-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/

Create operation of resource: neighbor

neighbor_schema

neighborbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "neighbor-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/

Delete operation of resource: neighbor

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/

Retrieve operation of resource: neighbor

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

neighbor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "neighbor-address": "string"
}

NEIGHBOR-AFS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/neighbor-afs/

Update operation of resource: neighbor-afs

neighbor-afs_schema

neighbor-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AFS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/neighbor-afs/

Create operation of resource: neighbor-afs

neighbor-afs_schema

neighbor-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AFS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/neighbor-afs/

Delete operation of resource: neighbor-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AFS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/neighbor-afs/

Retrieve operation of resource: neighbor-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

neighbor-afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

NEIGHBOR-AF - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/neighbor-afs/neighbor-af/{af-name}/

Update operation of resource: neighbor-af

ADVERTISE-VRF-IMP-DISABLE-V4

neighbor-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/neighbor-afs/neighbor-af/{af-name}/

Create operation of resource: neighbor-af

ADVERTISE-VRF-IMP-DISABLE-V4

neighbor-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/neighbor-afs/neighbor-af/{af-name}/

Delete operation of resource: neighbor-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/neighbor-afs/neighbor-af/{af-name}/

Retrieve operation of resource: neighbor-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

ADVERTISE-VRF-IMP-DISABLE-V4

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

AIGP-COST-COMMUNITY - Update

Update operation of resource: aigp-cost-community

aigp-cost-community_schema

aigp-cost-communitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Create

Create operation of resource: aigp-cost-community

aigp-cost-community_schema

aigp-cost-communitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Delete

Delete operation of resource: aigp-cost-community

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Retrieve

Retrieve operation of resource: aigp-cost-community

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

aigp-cost-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

ADVERTISE-DEF-IMP-DISABLE-V6 - Update

Update operation of resource: advertise-def-imp-disable-v6

advertise-def-imp-disable-v6_schema

advertise-def-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Create

Create operation of resource: advertise-def-imp-disable-v6

advertise-def-imp-disable-v6_schema

advertise-def-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Delete

Delete operation of resource: advertise-def-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Retrieve

Retrieve operation of resource: advertise-def-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-def-imp-disable-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-DISABLE - Update

Update operation of resource: advertise-disable

advertise-disable_schema

advertise-disablebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Create

Create operation of resource: advertise-disable

advertise-disable_schema

advertise-disablebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Delete

Delete operation of resource: advertise-disable

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Retrieve

Retrieve operation of resource: advertise-disable

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-disable_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

MAXIMUM-PREFIXES - Update

Update operation of resource: maximum-prefixes

maximum-prefixes_schema

maximum-prefixesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Create

Create operation of resource: maximum-prefixes

maximum-prefixes_schema

maximum-prefixesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Delete

Delete operation of resource: maximum-prefixes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Retrieve

Retrieve operation of resource: maximum-prefixes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

maximum-prefixes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Update

Update operation of resource: remove-private-as-entire-as-path-inbound

remove-private-as-entire-as-path-inbound_schema

remove-private-as-entire-as-path-inboundbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Create

Create operation of resource: remove-private-as-entire-as-path-inbound

remove-private-as-entire-as-path-inbound_schema

remove-private-as-entire-as-path-inboundbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Delete

Delete operation of resource: remove-private-as-entire-as-path-inbound

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Retrieve

Retrieve operation of resource: remove-private-as-entire-as-path-inbound

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

remove-private-as-entire-as-path-inbound_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "entire": "boolean",
  "enable": "boolean"
}

ADVERTISE-DEF-IMP-DISABLE-V4 - Update

Update operation of resource: advertise-def-imp-disable-v4

advertise-def-imp-disable-v4_schema

advertise-def-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Create

Create operation of resource: advertise-def-imp-disable-v4

advertise-def-imp-disable-v4_schema

advertise-def-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Delete

Delete operation of resource: advertise-def-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Retrieve

Retrieve operation of resource: advertise-def-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-def-imp-disable-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-L2VPN-EVPN - Update

Update operation of resource: advertise-l2vpn-evpn

advertise-l2vpn-evpn_schema

advertise-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Create

Create operation of resource: advertise-l2vpn-evpn

advertise-l2vpn-evpn_schema

advertise-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Delete

Delete operation of resource: advertise-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Retrieve

Retrieve operation of resource: advertise-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-l2vpn-evpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-L2VPN-EVPN - Update

Update operation of resource: advertise-local-l2vpn-evpn

advertise-local-l2vpn-evpn_schema

advertise-local-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Create

Create operation of resource: advertise-local-l2vpn-evpn

advertise-local-l2vpn-evpn_schema

advertise-local-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Delete

Delete operation of resource: advertise-local-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Retrieve

Retrieve operation of resource: advertise-local-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-local-l2vpn-evpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Update

Update operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

neighbor-af-long-lived-graceful-restart-stale-time_schema

neighbor-af-long-lived-graceful-restart-stale-timebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Create

Create operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

neighbor-af-long-lived-graceful-restart-stale-time_schema

neighbor-af-long-lived-graceful-restart-stale-timebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Delete

Delete operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Retrieve

Retrieve operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

neighbor-af-long-lived-graceful-restart-stale-time_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

ADVERTISE-V6 - Update

Update operation of resource: advertise-v6

advertise-v6_schema

advertise-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Create

Create operation of resource: advertise-v6

advertise-v6_schema

advertise-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Delete

Delete operation of resource: advertise-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Retrieve

Retrieve operation of resource: advertise-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-V6 - Update

Update operation of resource: advertise-local-v6

advertise-local-v6_schema

advertise-local-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Create

Create operation of resource: advertise-local-v6

advertise-local-v6_schema

advertise-local-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Delete

Delete operation of resource: advertise-local-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Retrieve

Retrieve operation of resource: advertise-local-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-local-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

IMPORT - Update

Update operation of resource: import

import_schema

importbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Create

Create operation of resource: import

import_schema

importbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Delete

Delete operation of resource: import

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Retrieve

Retrieve operation of resource: import

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

import_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

DEFAULT-ORIGINATE - Update

Update operation of resource: default-originate

default-originate_schema

default-originatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Create

Create operation of resource: default-originate

default-originate_schema

default-originatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Delete

Delete operation of resource: default-originate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Retrieve

Retrieve operation of resource: default-originate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

default-originate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": "boolean",
  "route-policy-name": "string"
}

SOFT-RECONFIGURATION - Update

Update operation of resource: soft-reconfiguration

soft-reconfiguration_schema

soft-reconfigurationbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Create

Create operation of resource: soft-reconfiguration

soft-reconfiguration_schema

soft-reconfigurationbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Delete

Delete operation of resource: soft-reconfiguration

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Retrieve

Retrieve operation of resource: soft-reconfiguration

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

soft-reconfiguration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

ADVERTISE-VRF-IMP-DISABLE-V6 - Update

Update operation of resource: advertise-vrf-imp-disable-v6

advertise-vrf-imp-disable-v6_schema

advertise-vrf-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Create

Create operation of resource: advertise-vrf-imp-disable-v6

advertise-vrf-imp-disable-v6_schema

advertise-vrf-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Delete

Delete operation of resource: advertise-vrf-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Retrieve

Retrieve operation of resource: advertise-vrf-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-vrf-imp-disable-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-V4 - Update

Update operation of resource: advertise-v4

advertise-v4_schema

advertise-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Create

Create operation of resource: advertise-v4

advertise-v4_schema

advertise-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Delete

Delete operation of resource: advertise-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Retrieve

Retrieve operation of resource: advertise-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-V4 - Update

Update operation of resource: advertise-local-v4

advertise-local-v4_schema

advertise-local-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Create

Create operation of resource: advertise-local-v4

advertise-local-v4_schema

advertise-local-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Delete

Delete operation of resource: advertise-local-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Retrieve

Retrieve operation of resource: advertise-local-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-local-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Update

Update operation of resource: remove-private-as-entire-as-path

remove-private-as-entire-as-path_schema

remove-private-as-entire-as-pathbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Create

Create operation of resource: remove-private-as-entire-as-path

remove-private-as-entire-as-path_schema

remove-private-as-entire-as-pathbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Delete

Delete operation of resource: remove-private-as-entire-as-path

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Retrieve

Retrieve operation of resource: remove-private-as-entire-as-path

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

remove-private-as-entire-as-path_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "entire": "boolean",
  "enable": "boolean"
}

ADVERTISE-VRF-IMP-DISABLE-V4 - Update

Update operation of resource: advertise-vrf-imp-disable-v4

advertise-vrf-imp-disable-v4_schema

advertise-vrf-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Create

Create operation of resource: advertise-vrf-imp-disable-v4

advertise-vrf-imp-disable-v4_schema

advertise-vrf-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Delete

Delete operation of resource: advertise-vrf-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Retrieve

Retrieve operation of resource: advertise-vrf-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-vrf-imp-disable-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

LOCAL-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/local-address/

Update operation of resource: local-address

local-address_schema

local-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/local-address/

Create operation of resource: local-address

local-address_schema

local-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/local-address/

Delete operation of resource: local-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/local-address/

Retrieve operation of resource: local-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

local-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

BMP-ACTIVATES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/bmp-activates/

Update operation of resource: bmp-activates

bmp-activates_schema

bmp-activatesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/bmp-activates/

Create operation of resource: bmp-activates

bmp-activates_schema

bmp-activatesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/bmp-activates/

Delete operation of resource: bmp-activates

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/bmp-activates/

Retrieve operation of resource: bmp-activates

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

bmp-activates_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

BMP-ACTIVATE - Update

Update operation of resource: bmp-activate

bmp-activate_schema

bmp-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "server-id": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Create

Create operation of resource: bmp-activate

bmp-activate_schema

bmp-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "server-id": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Delete

Delete operation of resource: bmp-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

server-id

in path

string

ID of server-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Retrieve

Retrieve operation of resource: bmp-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

server-id

in path

string

ID of server-id

200 OK

bmp-activate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "server-id": "integer"
}

EBGP-MULTIHOP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/ebgp-multihop/

Update operation of resource: ebgp-multihop

ebgp-multihop_schema

ebgp-multihopbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/ebgp-multihop/

Create operation of resource: ebgp-multihop

ebgp-multihop_schema

ebgp-multihopbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/ebgp-multihop/

Delete operation of resource: ebgp-multihop

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/ebgp-multihop/

Retrieve operation of resource: ebgp-multihop

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

ebgp-multihop_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

REMOTE-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/remote-as/

Update operation of resource: remote-as

remote-as_schema

remote-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/remote-as/

Create operation of resource: remote-as

remote-as_schema

remote-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/remote-as/

Delete operation of resource: remote-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/remote-as/

Retrieve operation of resource: remote-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

remote-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-xx": "string",
  "as-yy": "string"
}

LOCAL-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/local-as/

Update operation of resource: local-as

local-as_schema

local-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/local-as/

Create operation of resource: local-as

local-as_schema

local-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/local-as/

Delete operation of resource: local-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/local-as/

Retrieve operation of resource: local-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

local-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

PASSWORD - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/password/

Update operation of resource: password

password_schema

passwordbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "password-disable": "boolean",
  "password": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/password/

Create operation of resource: password

password_schema

passwordbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "password-disable": "boolean",
  "password": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/password/

Delete operation of resource: password

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/password/

Retrieve operation of resource: password

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

password_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "password-disable": "boolean",
  "password": "string"
}

ADVERTISEMENT-INTERVAL - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/advertisement-interval/

Update operation of resource: advertisement-interval

advertisement-interval_schema

advertisement-intervalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/advertisement-interval/

Create operation of resource: advertisement-interval

advertisement-interval_schema

advertisement-intervalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/advertisement-interval/

Delete operation of resource: advertisement-interval

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/advertisement-interval/

Retrieve operation of resource: advertisement-interval

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

advertisement-interval_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

NEIGHBOR-CLUSTER-ID - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/neighbor-cluster-id/

Update operation of resource: neighbor-cluster-id

neighbor-cluster-id_schema

neighbor-cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/neighbor-cluster-id/

Create operation of resource: neighbor-cluster-id

neighbor-cluster-id_schema

neighbor-cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/neighbor-cluster-id/

Delete operation of resource: neighbor-cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/neighbor-cluster-id/

Retrieve operation of resource: neighbor-cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

neighbor-cluster-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

TCPMSS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/tcpmss/

Update operation of resource: tcpmss

tcpmss_schema

tcpmssbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/tcpmss/

Create operation of resource: tcpmss

tcpmss_schema

tcpmssbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/tcpmss/

Delete operation of resource: tcpmss

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/tcpmss/

Retrieve operation of resource: tcpmss

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

tcpmss_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

TOS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/tos/

Update operation of resource: tos

tos_schema

tosbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/tos/

Create operation of resource: tos

tos_schema

tosbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/tos/

Delete operation of resource: tos

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/tos/

Retrieve operation of resource: tos

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "type": "string",
  "value": "string"
}

UPDATE-IN-FILTERING - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/update-in-filtering/

Update operation of resource: update-in-filtering

update-in-filtering_schema

update-in-filteringbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/update-in-filtering/

Create operation of resource: update-in-filtering

update-in-filtering_schema

update-in-filteringbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/update-in-filtering/

Delete operation of resource: update-in-filtering

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/update-in-filtering/

Retrieve operation of resource: update-in-filtering

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

update-in-filtering_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Update

Update operation of resource: update-in-filtering-message-buffers

update-in-filtering-message-buffers_schema

update-in-filtering-message-buffersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Create

Create operation of resource: update-in-filtering-message-buffers

update-in-filtering-message-buffers_schema

update-in-filtering-message-buffersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Delete

Delete operation of resource: update-in-filtering-message-buffers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Retrieve

Retrieve operation of resource: update-in-filtering-message-buffers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

update-in-filtering-message-buffers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

MSG-LOG-OUT - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/msg-log-out/

Update operation of resource: msg-log-out

msg-log-out_schema

msg-log-outbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/msg-log-out/

Create operation of resource: msg-log-out

msg-log-out_schema

msg-log-outbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/msg-log-out/

Delete operation of resource: msg-log-out

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/msg-log-out/

Retrieve operation of resource: msg-log-out

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

msg-log-out_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

AO-KEYCHAIN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/ao-keychain/

Update operation of resource: ao-keychain

ao-keychain_schema

ao-keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/ao-keychain/

Create operation of resource: ao-keychain

ao-keychain_schema

ao-keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/ao-keychain/

Delete operation of resource: ao-keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/ao-keychain/

Retrieve operation of resource: ao-keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

ao-keychain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

RECEIVE-BUFFER-SIZE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/receive-buffer-size/

Update operation of resource: receive-buffer-size

receive-buffer-size_schema

receive-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/receive-buffer-size/

Create operation of resource: receive-buffer-size

receive-buffer-size_schema

receive-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/receive-buffer-size/

Delete operation of resource: receive-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/receive-buffer-size/

Retrieve operation of resource: receive-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

receive-buffer-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

MSG-LOG-IN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/msg-log-in/

Update operation of resource: msg-log-in

msg-log-in_schema

msg-log-inbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/msg-log-in/

Create operation of resource: msg-log-in

msg-log-in_schema

msg-log-inbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/msg-log-in/

Delete operation of resource: msg-log-in

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/msg-log-in/

Retrieve operation of resource: msg-log-in

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

msg-log-in_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

SEND-BUFFER-SIZE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/send-buffer-size/

Update operation of resource: send-buffer-size

send-buffer-size_schema

send-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/send-buffer-size/

Create operation of resource: send-buffer-size

send-buffer-size_schema

send-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/send-buffer-size/

Delete operation of resource: send-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/send-buffer-size/

Retrieve operation of resource: send-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

send-buffer-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

TIMERS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/timers/

Update operation of resource: timers

timers_schema

timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/timers/

Create operation of resource: timers

timers_schema

timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/timers/

Delete operation of resource: timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/timers/

Retrieve operation of resource: timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

timers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

KEYCHAIN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/keychain/

Update operation of resource: keychain

keychain_schema

keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/keychain/

Create operation of resource: keychain

keychain_schema

keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/keychain/

Delete operation of resource: keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/keychain/

Retrieve operation of resource: keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

keychain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

GRACEFUL-MAINTENANCE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/graceful-maintenance/

Update operation of resource: graceful-maintenance

graceful-maintenance_schema

graceful-maintenancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/graceful-maintenance/

Create operation of resource: graceful-maintenance

graceful-maintenance_schema

graceful-maintenancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/graceful-maintenance/

Delete operation of resource: graceful-maintenance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor/{neighbor-address}/graceful-maintenance/

Retrieve operation of resource: graceful-maintenance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

graceful-maintenance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Update

Update operation of resource: graceful-maintenance-local-preference

graceful-maintenance-local-preference_schema

graceful-maintenance-local-preferencebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Create

Create operation of resource: graceful-maintenance-local-preference

graceful-maintenance-local-preference_schema

graceful-maintenance-local-preferencebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Delete

Delete operation of resource: graceful-maintenance-local-preference

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Retrieve

Retrieve operation of resource: graceful-maintenance-local-preference

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

graceful-maintenance-local-preference_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

GRACEFUL-MAINTENANCE-AS-PREPENDS - Update

Update operation of resource: graceful-maintenance-as-prepends

graceful-maintenance-as-prepends_schema

graceful-maintenance-as-prependsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Create

Create operation of resource: graceful-maintenance-as-prepends

graceful-maintenance-as-prepends_schema

graceful-maintenance-as-prependsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

Request Content-Types: application/json

Request Example

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Delete

Delete operation of resource: graceful-maintenance-as-prepends

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Retrieve

Retrieve operation of resource: graceful-maintenance-as-prepends

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-address

in path

string

ID of neighbor-address

200 OK

graceful-maintenance-as-prepends_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

NEIGHBOR-PREFIX-LENGTH - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor-prefix-length/{prefix-length neighbor-address}/

Update operation of resource: neighbor-prefix-length

neighbor-prefix-length_schema

neighbor-prefix-lengthbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "neighbor-address": "string",
  "prefix-length": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-PREFIX-LENGTH - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor-prefix-length/{prefix-length neighbor-address}/

Create operation of resource: neighbor-prefix-length

neighbor-prefix-length_schema

neighbor-prefix-lengthbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "neighbor-address": "string",
  "prefix-length": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-PREFIX-LENGTH - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor-prefix-length/{prefix-length neighbor-address}/

Delete operation of resource: neighbor-prefix-length

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-PREFIX-LENGTH - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor-prefix-length/{prefix-length neighbor-address}/

Retrieve operation of resource: neighbor-prefix-length

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

neighbor-prefix-length_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "neighbor-address": "string",
  "prefix-length": "integer"
}

NEIGHBOR-AFS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor-prefix-length/{prefix-length neighbor-address}/neighbor-afs/

Update operation of resource: neighbor-afs

neighbor-afs_schema

neighbor-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AFS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor-prefix-length/{prefix-length neighbor-address}/neighbor-afs/

Create operation of resource: neighbor-afs

neighbor-afs_schema

neighbor-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AFS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor-prefix-length/{prefix-length neighbor-address}/neighbor-afs/

Delete operation of resource: neighbor-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AFS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor-prefix-length/{prefix-length neighbor-address}/neighbor-afs/

Retrieve operation of resource: neighbor-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

neighbor-afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

NEIGHBOR-AF - Update

Update operation of resource: neighbor-af

ADVERTISE-VRF-IMP-DISABLE-V4

neighbor-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF - Create

Create operation of resource: neighbor-af

ADVERTISE-VRF-IMP-DISABLE-V4

neighbor-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF - Delete

Delete operation of resource: neighbor-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF - Retrieve

Retrieve operation of resource: neighbor-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

ADVERTISE-VRF-IMP-DISABLE-V4

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

AIGP-COST-COMMUNITY - Update

Update operation of resource: aigp-cost-community

aigp-cost-community_schema

aigp-cost-communitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Create

Create operation of resource: aigp-cost-community

aigp-cost-community_schema

aigp-cost-communitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Delete

Delete operation of resource: aigp-cost-community

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Retrieve

Retrieve operation of resource: aigp-cost-community

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

aigp-cost-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

ADVERTISE-DEF-IMP-DISABLE-V6 - Update

Update operation of resource: advertise-def-imp-disable-v6

advertise-def-imp-disable-v6_schema

advertise-def-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Create

Create operation of resource: advertise-def-imp-disable-v6

advertise-def-imp-disable-v6_schema

advertise-def-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Delete

Delete operation of resource: advertise-def-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Retrieve

Retrieve operation of resource: advertise-def-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-def-imp-disable-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-DISABLE - Update

Update operation of resource: advertise-disable

advertise-disable_schema

advertise-disablebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Create

Create operation of resource: advertise-disable

advertise-disable_schema

advertise-disablebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Delete

Delete operation of resource: advertise-disable

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Retrieve

Retrieve operation of resource: advertise-disable

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-disable_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

MAXIMUM-PREFIXES - Update

Update operation of resource: maximum-prefixes

maximum-prefixes_schema

maximum-prefixesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Create

Create operation of resource: maximum-prefixes

maximum-prefixes_schema

maximum-prefixesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Delete

Delete operation of resource: maximum-prefixes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Retrieve

Retrieve operation of resource: maximum-prefixes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

maximum-prefixes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Update

Update operation of resource: remove-private-as-entire-as-path-inbound

remove-private-as-entire-as-path-inbound_schema

remove-private-as-entire-as-path-inboundbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Create

Create operation of resource: remove-private-as-entire-as-path-inbound

remove-private-as-entire-as-path-inbound_schema

remove-private-as-entire-as-path-inboundbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Delete

Delete operation of resource: remove-private-as-entire-as-path-inbound

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Retrieve

Retrieve operation of resource: remove-private-as-entire-as-path-inbound

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

remove-private-as-entire-as-path-inbound_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "entire": "boolean",
  "enable": "boolean"
}

ADVERTISE-DEF-IMP-DISABLE-V4 - Update

Update operation of resource: advertise-def-imp-disable-v4

advertise-def-imp-disable-v4_schema

advertise-def-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Create

Create operation of resource: advertise-def-imp-disable-v4

advertise-def-imp-disable-v4_schema

advertise-def-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Delete

Delete operation of resource: advertise-def-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Retrieve

Retrieve operation of resource: advertise-def-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-def-imp-disable-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-L2VPN-EVPN - Update

Update operation of resource: advertise-l2vpn-evpn

advertise-l2vpn-evpn_schema

advertise-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Create

Create operation of resource: advertise-l2vpn-evpn

advertise-l2vpn-evpn_schema

advertise-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Delete

Delete operation of resource: advertise-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Retrieve

Retrieve operation of resource: advertise-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-l2vpn-evpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-L2VPN-EVPN - Update

Update operation of resource: advertise-local-l2vpn-evpn

advertise-local-l2vpn-evpn_schema

advertise-local-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Create

Create operation of resource: advertise-local-l2vpn-evpn

advertise-local-l2vpn-evpn_schema

advertise-local-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Delete

Delete operation of resource: advertise-local-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Retrieve

Retrieve operation of resource: advertise-local-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-local-l2vpn-evpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Update

Update operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

neighbor-af-long-lived-graceful-restart-stale-time_schema

neighbor-af-long-lived-graceful-restart-stale-timebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Create

Create operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

neighbor-af-long-lived-graceful-restart-stale-time_schema

neighbor-af-long-lived-graceful-restart-stale-timebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Delete

Delete operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Retrieve

Retrieve operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

neighbor-af-long-lived-graceful-restart-stale-time_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

ADVERTISE-V6 - Update

Update operation of resource: advertise-v6

advertise-v6_schema

advertise-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Create

Create operation of resource: advertise-v6

advertise-v6_schema

advertise-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Delete

Delete operation of resource: advertise-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Retrieve

Retrieve operation of resource: advertise-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-V6 - Update

Update operation of resource: advertise-local-v6

advertise-local-v6_schema

advertise-local-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Create

Create operation of resource: advertise-local-v6

advertise-local-v6_schema

advertise-local-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Delete

Delete operation of resource: advertise-local-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Retrieve

Retrieve operation of resource: advertise-local-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-local-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

IMPORT - Update

Update operation of resource: import

import_schema

importbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Create

Create operation of resource: import

import_schema

importbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Delete

Delete operation of resource: import

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Retrieve

Retrieve operation of resource: import

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

import_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

DEFAULT-ORIGINATE - Update

Update operation of resource: default-originate

default-originate_schema

default-originatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Create

Create operation of resource: default-originate

default-originate_schema

default-originatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Delete

Delete operation of resource: default-originate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Retrieve

Retrieve operation of resource: default-originate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

default-originate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": "boolean",
  "route-policy-name": "string"
}

SOFT-RECONFIGURATION - Update

Update operation of resource: soft-reconfiguration

soft-reconfiguration_schema

soft-reconfigurationbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Create

Create operation of resource: soft-reconfiguration

soft-reconfiguration_schema

soft-reconfigurationbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Delete

Delete operation of resource: soft-reconfiguration

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Retrieve

Retrieve operation of resource: soft-reconfiguration

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

soft-reconfiguration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

ADVERTISE-VRF-IMP-DISABLE-V6 - Update

Update operation of resource: advertise-vrf-imp-disable-v6

advertise-vrf-imp-disable-v6_schema

advertise-vrf-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Create

Create operation of resource: advertise-vrf-imp-disable-v6

advertise-vrf-imp-disable-v6_schema

advertise-vrf-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Delete

Delete operation of resource: advertise-vrf-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Retrieve

Retrieve operation of resource: advertise-vrf-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-vrf-imp-disable-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-V4 - Update

Update operation of resource: advertise-v4

advertise-v4_schema

advertise-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Create

Create operation of resource: advertise-v4

advertise-v4_schema

advertise-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Delete

Delete operation of resource: advertise-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Retrieve

Retrieve operation of resource: advertise-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-V4 - Update

Update operation of resource: advertise-local-v4

advertise-local-v4_schema

advertise-local-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Create

Create operation of resource: advertise-local-v4

advertise-local-v4_schema

advertise-local-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Delete

Delete operation of resource: advertise-local-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Retrieve

Retrieve operation of resource: advertise-local-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-local-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Update

Update operation of resource: remove-private-as-entire-as-path

remove-private-as-entire-as-path_schema

remove-private-as-entire-as-pathbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Create

Create operation of resource: remove-private-as-entire-as-path

remove-private-as-entire-as-path_schema

remove-private-as-entire-as-pathbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Delete

Delete operation of resource: remove-private-as-entire-as-path

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Retrieve

Retrieve operation of resource: remove-private-as-entire-as-path

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

remove-private-as-entire-as-path_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "entire": "boolean",
  "enable": "boolean"
}

ADVERTISE-VRF-IMP-DISABLE-V4 - Update

Update operation of resource: advertise-vrf-imp-disable-v4

advertise-vrf-imp-disable-v4_schema

advertise-vrf-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Create

Create operation of resource: advertise-vrf-imp-disable-v4

advertise-vrf-imp-disable-v4_schema

advertise-vrf-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Delete

Delete operation of resource: advertise-vrf-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Retrieve

Retrieve operation of resource: advertise-vrf-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

af-name

in path

string

ID of af-name

200 OK

advertise-vrf-imp-disable-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

LOCAL-ADDRESS - Update

Update operation of resource: local-address

local-address_schema

local-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Create

Create operation of resource: local-address

local-address_schema

local-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Delete

Delete operation of resource: local-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Retrieve

Retrieve operation of resource: local-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

local-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

BMP-ACTIVATES - Update

Update operation of resource: bmp-activates

bmp-activates_schema

bmp-activatesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Create

Create operation of resource: bmp-activates

bmp-activates_schema

bmp-activatesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Delete

Delete operation of resource: bmp-activates

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Retrieve

Retrieve operation of resource: bmp-activates

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

bmp-activates_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

BMP-ACTIVATE - Update

Update operation of resource: bmp-activate

bmp-activate_schema

bmp-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "server-id": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Create

Create operation of resource: bmp-activate

bmp-activate_schema

bmp-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "server-id": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Delete

Delete operation of resource: bmp-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

server-id

in path

string

ID of server-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Retrieve

Retrieve operation of resource: bmp-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

server-id

in path

string

ID of server-id

200 OK

bmp-activate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "server-id": "integer"
}

EBGP-MULTIHOP - Update

Update operation of resource: ebgp-multihop

ebgp-multihop_schema

ebgp-multihopbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Create

Create operation of resource: ebgp-multihop

ebgp-multihop_schema

ebgp-multihopbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Delete

Delete operation of resource: ebgp-multihop

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Retrieve

Retrieve operation of resource: ebgp-multihop

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

ebgp-multihop_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

REMOTE-AS - Update

Update operation of resource: remote-as

remote-as_schema

remote-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Create

Create operation of resource: remote-as

remote-as_schema

remote-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Delete

Delete operation of resource: remote-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Retrieve

Retrieve operation of resource: remote-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

remote-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-xx": "string",
  "as-yy": "string"
}

LOCAL-AS - Update

Update operation of resource: local-as

local-as_schema

local-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Create

Create operation of resource: local-as

local-as_schema

local-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Delete

Delete operation of resource: local-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Retrieve

Retrieve operation of resource: local-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

local-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

PASSWORD - Update

Update operation of resource: password

password_schema

passwordbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "password-disable": "boolean",
  "password": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Create

Create operation of resource: password

password_schema

passwordbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "password-disable": "boolean",
  "password": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Delete

Delete operation of resource: password

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Retrieve

Retrieve operation of resource: password

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

password_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "password-disable": "boolean",
  "password": "string"
}

ADVERTISEMENT-INTERVAL - Update

Update operation of resource: advertisement-interval

advertisement-interval_schema

advertisement-intervalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Create

Create operation of resource: advertisement-interval

advertisement-interval_schema

advertisement-intervalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Delete

Delete operation of resource: advertisement-interval

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Retrieve

Retrieve operation of resource: advertisement-interval

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

advertisement-interval_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

NEIGHBOR-CLUSTER-ID - Update

Update operation of resource: neighbor-cluster-id

neighbor-cluster-id_schema

neighbor-cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Create

Create operation of resource: neighbor-cluster-id

neighbor-cluster-id_schema

neighbor-cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Delete

Delete operation of resource: neighbor-cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Retrieve

Retrieve operation of resource: neighbor-cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

neighbor-cluster-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

TCPMSS - Update

Update operation of resource: tcpmss

tcpmss_schema

tcpmssbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Create

Create operation of resource: tcpmss

tcpmss_schema

tcpmssbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Delete

Delete operation of resource: tcpmss

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Retrieve

Retrieve operation of resource: tcpmss

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

tcpmss_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

TOS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor-prefix-length/{prefix-length neighbor-address}/tos/

Update operation of resource: tos

tos_schema

tosbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

Create operation of resource: tos

tos_schema

tosbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

Delete operation of resource: tos

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbors/neighbor-prefix-length/{prefix-length neighbor-address}/tos/

Retrieve operation of resource: tos

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "type": "string",
  "value": "string"
}

UPDATE-IN-FILTERING - Update

Update operation of resource: update-in-filtering

update-in-filtering_schema

update-in-filteringbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Create

Create operation of resource: update-in-filtering

update-in-filtering_schema

update-in-filteringbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Delete

Delete operation of resource: update-in-filtering

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Retrieve

Retrieve operation of resource: update-in-filtering

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

update-in-filtering_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Update

Update operation of resource: update-in-filtering-message-buffers

update-in-filtering-message-buffers_schema

update-in-filtering-message-buffersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Create

Create operation of resource: update-in-filtering-message-buffers

update-in-filtering-message-buffers_schema

update-in-filtering-message-buffersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Delete

Delete operation of resource: update-in-filtering-message-buffers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Retrieve

Retrieve operation of resource: update-in-filtering-message-buffers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

update-in-filtering-message-buffers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

MSG-LOG-OUT - Update

Update operation of resource: msg-log-out

msg-log-out_schema

msg-log-outbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Create

Create operation of resource: msg-log-out

msg-log-out_schema

msg-log-outbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Delete

Delete operation of resource: msg-log-out

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Retrieve

Retrieve operation of resource: msg-log-out

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

msg-log-out_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

AO-KEYCHAIN - Update

Update operation of resource: ao-keychain

ao-keychain_schema

ao-keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Create

Create operation of resource: ao-keychain

ao-keychain_schema

ao-keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Delete

Delete operation of resource: ao-keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Retrieve

Retrieve operation of resource: ao-keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

ao-keychain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

RECEIVE-BUFFER-SIZE - Update

Update operation of resource: receive-buffer-size

receive-buffer-size_schema

receive-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Create

Create operation of resource: receive-buffer-size

receive-buffer-size_schema

receive-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Delete

Delete operation of resource: receive-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Retrieve

Retrieve operation of resource: receive-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

receive-buffer-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

MSG-LOG-IN - Update

Update operation of resource: msg-log-in

msg-log-in_schema

msg-log-inbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Create

Create operation of resource: msg-log-in

msg-log-in_schema

msg-log-inbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Delete

Delete operation of resource: msg-log-in

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Retrieve

Retrieve operation of resource: msg-log-in

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

msg-log-in_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

SEND-BUFFER-SIZE - Update

Update operation of resource: send-buffer-size

send-buffer-size_schema

send-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Create

Create operation of resource: send-buffer-size

send-buffer-size_schema

send-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Delete

Delete operation of resource: send-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Retrieve

Retrieve operation of resource: send-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

send-buffer-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

TIMERS - Update

Update operation of resource: timers

timers_schema

timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Create

Create operation of resource: timers

timers_schema

timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Delete

Delete operation of resource: timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Retrieve

Retrieve operation of resource: timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

timers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

KEYCHAIN - Update

Update operation of resource: keychain

keychain_schema

keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Create

Create operation of resource: keychain

keychain_schema

keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Delete

Delete operation of resource: keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Retrieve

Retrieve operation of resource: keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

keychain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

GRACEFUL-MAINTENANCE - Update

Update operation of resource: graceful-maintenance

graceful-maintenance_schema

graceful-maintenancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Create

Create operation of resource: graceful-maintenance

graceful-maintenance_schema

graceful-maintenancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Delete

Delete operation of resource: graceful-maintenance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Retrieve

Retrieve operation of resource: graceful-maintenance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

graceful-maintenance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Update

Update operation of resource: graceful-maintenance-local-preference

graceful-maintenance-local-preference_schema

graceful-maintenance-local-preferencebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Create

Create operation of resource: graceful-maintenance-local-preference

graceful-maintenance-local-preference_schema

graceful-maintenance-local-preferencebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Delete

Delete operation of resource: graceful-maintenance-local-preference

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Retrieve

Retrieve operation of resource: graceful-maintenance-local-preference

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

graceful-maintenance-local-preference_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

GRACEFUL-MAINTENANCE-AS-PREPENDS - Update

Update operation of resource: graceful-maintenance-as-prepends

graceful-maintenance-as-prepends_schema

graceful-maintenance-as-prependsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Create

Create operation of resource: graceful-maintenance-as-prepends

graceful-maintenance-as-prepends_schema

graceful-maintenance-as-prependsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

Request Content-Types: application/json

Request Example

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Delete

Delete operation of resource: graceful-maintenance-as-prepends

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Retrieve

Retrieve operation of resource: graceful-maintenance-as-prepends

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

prefix-length neighbor-address

in path

string

ID of prefix-length neighbor-address

200 OK

graceful-maintenance-as-prepends_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

NEIGHBOR-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/

Update operation of resource: neighbor-groups

neighbor-groups_schema

neighbor-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "neighbor-group": [
    {
      "neighbor-group-afs": {
        "neighbor-group-af": [
          {
            "af-name": "string",
            "advertise-vrf-imp-disable-v4": {
              "af-name": "string",
              "rt-type": "string",
              "adv-option": "string"
            }
          }
        ]
      },
      "neighbor-group-name": "string",
      "neighbor-group-add-member": "string",
      "graceful-maintenance": {
        "enable": [ null ],
        "graceful-maintenance-local-preference": {
          "local-preference": "integer",
          "gshut-loc-pref-disable": "boolean"
        },
        "graceful-maintenance-activate": "boolean",
        "graceful-maintenance-as-prepends": {
          "gshut-prepends-disable": "boolean",
          "as-prepends": "integer"
        }
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-GROUPS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/

Create operation of resource: neighbor-groups

neighbor-groups_schema

neighbor-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "neighbor-group": [
    {
      "neighbor-group-afs": {
        "neighbor-group-af": [
          {
            "af-name": "string",
            "advertise-vrf-imp-disable-v4": {
              "af-name": "string",
              "rt-type": "string",
              "adv-option": "string"
            }
          }
        ]
      },
      "neighbor-group-name": "string",
      "neighbor-group-add-member": "string",
      "graceful-maintenance": {
        "enable": [ null ],
        "graceful-maintenance-local-preference": {
          "local-preference": "integer",
          "gshut-loc-pref-disable": "boolean"
        },
        "graceful-maintenance-activate": "boolean",
        "graceful-maintenance-as-prepends": {
          "gshut-prepends-disable": "boolean",
          "as-prepends": "integer"
        }
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/

Delete operation of resource: neighbor-groups

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/

Retrieve operation of resource: neighbor-groups

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

neighbor-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "neighbor-group": [
    {
      "neighbor-group-afs": {
        "neighbor-group-af": [
          {
            "af-name": "string",
            "advertise-vrf-imp-disable-v4": {
              "af-name": "string",
              "rt-type": "string",
              "adv-option": "string"
            }
          }
        ]
      },
      "neighbor-group-name": "string",
      "neighbor-group-add-member": "string",
      "graceful-maintenance": {
        "enable": [ null ],
        "graceful-maintenance-local-preference": {
          "local-preference": "integer",
          "gshut-loc-pref-disable": "boolean"
        },
        "graceful-maintenance-activate": "boolean",
        "graceful-maintenance-as-prepends": {
          "gshut-prepends-disable": "boolean",
          "as-prepends": "integer"
        }
      }
    }
  ]
}

NEIGHBOR-GROUP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/

Update operation of resource: neighbor-group

neighbor-group_schema

neighbor-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "neighbor-group-afs": {
    "neighbor-group-af": [
      {
        "af-name": "string",
        "advertise-vrf-imp-disable-v4": {
          "af-name": "string",
          "rt-type": "string",
          "adv-option": "string"
        }
      }
    ]
  },
  "neighbor-group-name": "string",
  "neighbor-group-add-member": "string",
  "graceful-maintenance": {
    "enable": [ null ],
    "graceful-maintenance-local-preference": {
      "local-preference": "integer",
      "gshut-loc-pref-disable": "boolean"
    },
    "graceful-maintenance-activate": "boolean",
    "graceful-maintenance-as-prepends": {
      "gshut-prepends-disable": "boolean",
      "as-prepends": "integer"
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-GROUP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/

Create operation of resource: neighbor-group

neighbor-group_schema

neighbor-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "neighbor-group-afs": {
    "neighbor-group-af": [
      {
        "af-name": "string",
        "advertise-vrf-imp-disable-v4": {
          "af-name": "string",
          "rt-type": "string",
          "adv-option": "string"
        }
      }
    ]
  },
  "neighbor-group-name": "string",
  "neighbor-group-add-member": "string",
  "graceful-maintenance": {
    "enable": [ null ],
    "graceful-maintenance-local-preference": {
      "local-preference": "integer",
      "gshut-loc-pref-disable": "boolean"
    },
    "graceful-maintenance-activate": "boolean",
    "graceful-maintenance-as-prepends": {
      "gshut-prepends-disable": "boolean",
      "as-prepends": "integer"
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/

Delete operation of resource: neighbor-group

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/

Retrieve operation of resource: neighbor-group

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

neighbor-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "neighbor-group-afs": {
    "neighbor-group-af": [
      {
        "af-name": "string",
        "advertise-vrf-imp-disable-v4": {
          "af-name": "string",
          "rt-type": "string",
          "adv-option": "string"
        }
      }
    ]
  },
  "neighbor-group-name": "string",
  "neighbor-group-add-member": "string",
  "graceful-maintenance": {
    "enable": [ null ],
    "graceful-maintenance-local-preference": {
      "local-preference": "integer",
      "gshut-loc-pref-disable": "boolean"
    },
    "graceful-maintenance-activate": "boolean",
    "graceful-maintenance-as-prepends": {
      "gshut-prepends-disable": "boolean",
      "as-prepends": "integer"
    }
  }
}

NEIGHBOR-GROUP-AFS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/neighbor-group-afs/

Update operation of resource: neighbor-group-afs

neighbor-group-afs_schema

neighbor-group-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "neighbor-group-af": [
    {
      "af-name": "string",
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-GROUP-AFS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/neighbor-group-afs/

Create operation of resource: neighbor-group-afs

neighbor-group-afs_schema

neighbor-group-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "neighbor-group-af": [
    {
      "af-name": "string",
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-GROUP-AFS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/neighbor-group-afs/

Delete operation of resource: neighbor-group-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-GROUP-AFS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/neighbor-group-afs/

Retrieve operation of resource: neighbor-group-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

neighbor-group-afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "neighbor-group-af": [
    {
      "af-name": "string",
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

NEIGHBOR-GROUP-AF - Update

Update operation of resource: neighbor-group-af

neighbor-group-af_schema

neighbor-group-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-GROUP-AF - Create

Create operation of resource: neighbor-group-af

neighbor-group-af_schema

neighbor-group-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-GROUP-AF - Delete

Delete operation of resource: neighbor-group-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-GROUP-AF - Retrieve

Retrieve operation of resource: neighbor-group-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

neighbor-group-af_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

AIGP-COST-COMMUNITY - Update

Update operation of resource: aigp-cost-community

aigp-cost-community_schema

aigp-cost-communitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Create

Create operation of resource: aigp-cost-community

aigp-cost-community_schema

aigp-cost-communitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Delete

Delete operation of resource: aigp-cost-community

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Retrieve

Retrieve operation of resource: aigp-cost-community

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

aigp-cost-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

ADVERTISE-DEF-IMP-DISABLE-V6 - Update

Update operation of resource: advertise-def-imp-disable-v6

advertise-def-imp-disable-v6_schema

advertise-def-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Create

Create operation of resource: advertise-def-imp-disable-v6

advertise-def-imp-disable-v6_schema

advertise-def-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Delete

Delete operation of resource: advertise-def-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Retrieve

Retrieve operation of resource: advertise-def-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-def-imp-disable-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-DISABLE - Update

Update operation of resource: advertise-disable

advertise-disable_schema

advertise-disablebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Create

Create operation of resource: advertise-disable

advertise-disable_schema

advertise-disablebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Delete

Delete operation of resource: advertise-disable

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Retrieve

Retrieve operation of resource: advertise-disable

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-disable_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

MAXIMUM-PREFIXES - Update

Update operation of resource: maximum-prefixes

maximum-prefixes_schema

maximum-prefixesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Create

Create operation of resource: maximum-prefixes

maximum-prefixes_schema

maximum-prefixesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Delete

Delete operation of resource: maximum-prefixes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Retrieve

Retrieve operation of resource: maximum-prefixes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

maximum-prefixes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Update

Update operation of resource: remove-private-as-entire-as-path-inbound

remove-private-as-entire-as-path-inbound_schema

remove-private-as-entire-as-path-inboundbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Create

Create operation of resource: remove-private-as-entire-as-path-inbound

remove-private-as-entire-as-path-inbound_schema

remove-private-as-entire-as-path-inboundbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Delete

Delete operation of resource: remove-private-as-entire-as-path-inbound

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Retrieve

Retrieve operation of resource: remove-private-as-entire-as-path-inbound

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

remove-private-as-entire-as-path-inbound_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "entire": "boolean",
  "enable": "boolean"
}

ADVERTISE-DEF-IMP-DISABLE-V4 - Update

Update operation of resource: advertise-def-imp-disable-v4

advertise-def-imp-disable-v4_schema

advertise-def-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Create

Create operation of resource: advertise-def-imp-disable-v4

advertise-def-imp-disable-v4_schema

advertise-def-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Delete

Delete operation of resource: advertise-def-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Retrieve

Retrieve operation of resource: advertise-def-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-def-imp-disable-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-L2VPN-EVPN - Update

Update operation of resource: advertise-l2vpn-evpn

advertise-l2vpn-evpn_schema

advertise-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Create

Create operation of resource: advertise-l2vpn-evpn

advertise-l2vpn-evpn_schema

advertise-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Delete

Delete operation of resource: advertise-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Retrieve

Retrieve operation of resource: advertise-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-l2vpn-evpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-L2VPN-EVPN - Update

Update operation of resource: advertise-local-l2vpn-evpn

advertise-local-l2vpn-evpn_schema

advertise-local-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Create

Create operation of resource: advertise-local-l2vpn-evpn

advertise-local-l2vpn-evpn_schema

advertise-local-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Delete

Delete operation of resource: advertise-local-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Retrieve

Retrieve operation of resource: advertise-local-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-local-l2vpn-evpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Update

Update operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

neighbor-af-long-lived-graceful-restart-stale-time_schema

neighbor-af-long-lived-graceful-restart-stale-timebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Create

Create operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

neighbor-af-long-lived-graceful-restart-stale-time_schema

neighbor-af-long-lived-graceful-restart-stale-timebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Delete

Delete operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Retrieve

Retrieve operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

neighbor-af-long-lived-graceful-restart-stale-time_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

SITE-OF-ORIGIN - Update

Update operation of resource: site-of-origin

site-of-origin_schema

site-of-originbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SITE-OF-ORIGIN - Create

Create operation of resource: site-of-origin

site-of-origin_schema

site-of-originbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SITE-OF-ORIGIN - Delete

Delete operation of resource: site-of-origin

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SITE-OF-ORIGIN - Retrieve

Retrieve operation of resource: site-of-origin

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

site-of-origin_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

ADVERTISE-V6 - Update

Update operation of resource: advertise-v6

advertise-v6_schema

advertise-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Create

Create operation of resource: advertise-v6

advertise-v6_schema

advertise-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Delete

Delete operation of resource: advertise-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Retrieve

Retrieve operation of resource: advertise-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-V6 - Update

Update operation of resource: advertise-local-v6

advertise-local-v6_schema

advertise-local-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Create

Create operation of resource: advertise-local-v6

advertise-local-v6_schema

advertise-local-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Delete

Delete operation of resource: advertise-local-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Retrieve

Retrieve operation of resource: advertise-local-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-local-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

IMPORT - Update

Update operation of resource: import

import_schema

importbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Create

Create operation of resource: import

import_schema

importbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Delete

Delete operation of resource: import

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Retrieve

Retrieve operation of resource: import

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

import_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

DEFAULT-ORIGINATE - Update

Update operation of resource: default-originate

default-originate_schema

default-originatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Create

Create operation of resource: default-originate

default-originate_schema

default-originatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Delete

Delete operation of resource: default-originate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Retrieve

Retrieve operation of resource: default-originate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

default-originate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": "boolean",
  "route-policy-name": "string"
}

SOFT-RECONFIGURATION - Update

Update operation of resource: soft-reconfiguration

soft-reconfiguration_schema

soft-reconfigurationbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Create

Create operation of resource: soft-reconfiguration

soft-reconfiguration_schema

soft-reconfigurationbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Delete

Delete operation of resource: soft-reconfiguration

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Retrieve

Retrieve operation of resource: soft-reconfiguration

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

soft-reconfiguration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

ADVERTISE-VRF-IMP-DISABLE-V6 - Update

Update operation of resource: advertise-vrf-imp-disable-v6

advertise-vrf-imp-disable-v6_schema

advertise-vrf-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Create

Create operation of resource: advertise-vrf-imp-disable-v6

advertise-vrf-imp-disable-v6_schema

advertise-vrf-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Delete

Delete operation of resource: advertise-vrf-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Retrieve

Retrieve operation of resource: advertise-vrf-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-vrf-imp-disable-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-V4 - Update

Update operation of resource: advertise-v4

advertise-v4_schema

advertise-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Create

Create operation of resource: advertise-v4

advertise-v4_schema

advertise-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Delete

Delete operation of resource: advertise-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Retrieve

Retrieve operation of resource: advertise-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-V4 - Update

Update operation of resource: advertise-local-v4

advertise-local-v4_schema

advertise-local-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Create

Create operation of resource: advertise-local-v4

advertise-local-v4_schema

advertise-local-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Delete

Delete operation of resource: advertise-local-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Retrieve

Retrieve operation of resource: advertise-local-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-local-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Update

Update operation of resource: remove-private-as-entire-as-path

remove-private-as-entire-as-path_schema

remove-private-as-entire-as-pathbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Create

Create operation of resource: remove-private-as-entire-as-path

remove-private-as-entire-as-path_schema

remove-private-as-entire-as-pathbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Delete

Delete operation of resource: remove-private-as-entire-as-path

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Retrieve

Retrieve operation of resource: remove-private-as-entire-as-path

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

remove-private-as-entire-as-path_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "entire": "boolean",
  "enable": "boolean"
}

ADVERTISE-VRF-IMP-DISABLE-V4 - Update

Update operation of resource: advertise-vrf-imp-disable-v4

advertise-vrf-imp-disable-v4_schema

advertise-vrf-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Create

Create operation of resource: advertise-vrf-imp-disable-v4

advertise-vrf-imp-disable-v4_schema

advertise-vrf-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Delete

Delete operation of resource: advertise-vrf-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Retrieve

Retrieve operation of resource: advertise-vrf-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-vrf-imp-disable-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

LOCAL-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/local-address/

Update operation of resource: local-address

local-address_schema

local-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/local-address/

Create operation of resource: local-address

local-address_schema

local-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/local-address/

Delete operation of resource: local-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/local-address/

Retrieve operation of resource: local-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

local-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

BMP-ACTIVATES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/bmp-activates/

Update operation of resource: bmp-activates

bmp-activates_schema

bmp-activatesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/bmp-activates/

Create operation of resource: bmp-activates

bmp-activates_schema

bmp-activatesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/bmp-activates/

Delete operation of resource: bmp-activates

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/bmp-activates/

Retrieve operation of resource: bmp-activates

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

bmp-activates_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

BMP-ACTIVATE - Update

Update operation of resource: bmp-activate

bmp-activate_schema

bmp-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "server-id": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Create

Create operation of resource: bmp-activate

bmp-activate_schema

bmp-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "server-id": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Delete

Delete operation of resource: bmp-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

server-id

in path

string

ID of server-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Retrieve

Retrieve operation of resource: bmp-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

server-id

in path

string

ID of server-id

200 OK

bmp-activate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "server-id": "integer"
}

EBGP-MULTIHOP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/ebgp-multihop/

Update operation of resource: ebgp-multihop

ebgp-multihop_schema

ebgp-multihopbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/ebgp-multihop/

Create operation of resource: ebgp-multihop

ebgp-multihop_schema

ebgp-multihopbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/ebgp-multihop/

Delete operation of resource: ebgp-multihop

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/ebgp-multihop/

Retrieve operation of resource: ebgp-multihop

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

ebgp-multihop_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

REMOTE-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/remote-as/

Update operation of resource: remote-as

remote-as_schema

remote-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/remote-as/

Create operation of resource: remote-as

remote-as_schema

remote-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/remote-as/

Delete operation of resource: remote-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/remote-as/

Retrieve operation of resource: remote-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

remote-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-xx": "string",
  "as-yy": "string"
}

LOCAL-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/local-as/

Update operation of resource: local-as

local-as_schema

local-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/local-as/

Create operation of resource: local-as

local-as_schema

local-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/local-as/

Delete operation of resource: local-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/local-as/

Retrieve operation of resource: local-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

local-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

PASSWORD - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/password/

Update operation of resource: password

password_schema

passwordbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "password-disable": "boolean",
  "password": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/password/

Create operation of resource: password

password_schema

passwordbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "password-disable": "boolean",
  "password": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/password/

Delete operation of resource: password

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/password/

Retrieve operation of resource: password

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

password_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "password-disable": "boolean",
  "password": "string"
}

ADVERTISEMENT-INTERVAL - Update

Update operation of resource: advertisement-interval

advertisement-interval_schema

advertisement-intervalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Create

Create operation of resource: advertisement-interval

advertisement-interval_schema

advertisement-intervalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Delete

Delete operation of resource: advertisement-interval

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Retrieve

Retrieve operation of resource: advertisement-interval

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

advertisement-interval_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

NEIGHBOR-CLUSTER-ID - Update

Update operation of resource: neighbor-cluster-id

neighbor-cluster-id_schema

neighbor-cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Create

Create operation of resource: neighbor-cluster-id

neighbor-cluster-id_schema

neighbor-cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Delete

Delete operation of resource: neighbor-cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Retrieve

Retrieve operation of resource: neighbor-cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

neighbor-cluster-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

TCPMSS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/tcpmss/

Update operation of resource: tcpmss

tcpmss_schema

tcpmssbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/tcpmss/

Create operation of resource: tcpmss

tcpmss_schema

tcpmssbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/tcpmss/

Delete operation of resource: tcpmss

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/tcpmss/

Retrieve operation of resource: tcpmss

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

tcpmss_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

TOS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/tos/

Update operation of resource: tos

tos_schema

tosbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/tos/

Create operation of resource: tos

tos_schema

tosbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/tos/

Delete operation of resource: tos

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/tos/

Retrieve operation of resource: tos

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "type": "string",
  "value": "string"
}

UPDATE-IN-FILTERING - Update

Update operation of resource: update-in-filtering

update-in-filtering_schema

update-in-filteringbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Create

Create operation of resource: update-in-filtering

update-in-filtering_schema

update-in-filteringbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Delete

Delete operation of resource: update-in-filtering

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Retrieve

Retrieve operation of resource: update-in-filtering

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

update-in-filtering_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Update

Update operation of resource: update-in-filtering-message-buffers

update-in-filtering-message-buffers_schema

update-in-filtering-message-buffersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Create

Create operation of resource: update-in-filtering-message-buffers

update-in-filtering-message-buffers_schema

update-in-filtering-message-buffersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Delete

Delete operation of resource: update-in-filtering-message-buffers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Retrieve

Retrieve operation of resource: update-in-filtering-message-buffers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

update-in-filtering-message-buffers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

MSG-LOG-OUT - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/msg-log-out/

Update operation of resource: msg-log-out

msg-log-out_schema

msg-log-outbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/msg-log-out/

Create operation of resource: msg-log-out

msg-log-out_schema

msg-log-outbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/msg-log-out/

Delete operation of resource: msg-log-out

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/msg-log-out/

Retrieve operation of resource: msg-log-out

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

msg-log-out_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

AO-KEYCHAIN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/ao-keychain/

Update operation of resource: ao-keychain

ao-keychain_schema

ao-keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/ao-keychain/

Create operation of resource: ao-keychain

ao-keychain_schema

ao-keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/ao-keychain/

Delete operation of resource: ao-keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/ao-keychain/

Retrieve operation of resource: ao-keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

ao-keychain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

RECEIVE-BUFFER-SIZE - Update

Update operation of resource: receive-buffer-size

receive-buffer-size_schema

receive-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Create

Create operation of resource: receive-buffer-size

receive-buffer-size_schema

receive-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Delete

Delete operation of resource: receive-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Retrieve

Retrieve operation of resource: receive-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

receive-buffer-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

MSG-LOG-IN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/msg-log-in/

Update operation of resource: msg-log-in

msg-log-in_schema

msg-log-inbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/msg-log-in/

Create operation of resource: msg-log-in

msg-log-in_schema

msg-log-inbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/msg-log-in/

Delete operation of resource: msg-log-in

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/msg-log-in/

Retrieve operation of resource: msg-log-in

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

msg-log-in_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

SEND-BUFFER-SIZE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/send-buffer-size/

Update operation of resource: send-buffer-size

send-buffer-size_schema

send-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Create

Create operation of resource: send-buffer-size

send-buffer-size_schema

send-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Delete

Delete operation of resource: send-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/send-buffer-size/

Retrieve operation of resource: send-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

send-buffer-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

TIMERS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/timers/

Update operation of resource: timers

timers_schema

timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/timers/

Create operation of resource: timers

timers_schema

timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/timers/

Delete operation of resource: timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/timers/

Retrieve operation of resource: timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

timers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

KEYCHAIN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/keychain/

Update operation of resource: keychain

keychain_schema

keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/keychain/

Create operation of resource: keychain

keychain_schema

keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/keychain/

Delete operation of resource: keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/neighbor-groups/neighbor-group/{neighbor-group-name}/keychain/

Retrieve operation of resource: keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

keychain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

GRACEFUL-MAINTENANCE - Update

Update operation of resource: graceful-maintenance

graceful-maintenance_schema

graceful-maintenancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Create

Create operation of resource: graceful-maintenance

graceful-maintenance_schema

graceful-maintenancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Delete

Delete operation of resource: graceful-maintenance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Retrieve

Retrieve operation of resource: graceful-maintenance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

graceful-maintenance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Update

Update operation of resource: graceful-maintenance-local-preference

graceful-maintenance-local-preference_schema

graceful-maintenance-local-preferencebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Create

Create operation of resource: graceful-maintenance-local-preference

graceful-maintenance-local-preference_schema

graceful-maintenance-local-preferencebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Delete

Delete operation of resource: graceful-maintenance-local-preference

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Retrieve

Retrieve operation of resource: graceful-maintenance-local-preference

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

graceful-maintenance-local-preference_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

GRACEFUL-MAINTENANCE-AS-PREPENDS - Update

Update operation of resource: graceful-maintenance-as-prepends

graceful-maintenance-as-prepends_schema

graceful-maintenance-as-prependsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Create

Create operation of resource: graceful-maintenance-as-prepends

graceful-maintenance-as-prepends_schema

graceful-maintenance-as-prependsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

Request Content-Types: application/json

Request Example

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Delete

Delete operation of resource: graceful-maintenance-as-prepends

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Retrieve

Retrieve operation of resource: graceful-maintenance-as-prepends

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

neighbor-group-name

in path

string

ID of neighbor-group-name

200 OK

graceful-maintenance-as-prepends_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

AF-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/

Update operation of resource: af-groups

af-groups_schema

af-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "af-group": [
    {
      "af-group-name": "string",
      "af-group-afs": {
        "af-group-af": [
          {
            "af-name": "string",
            "create": [ null ],
            "af-group": "string",
            "advertise-vrf-imp-disable-v4": {
              "af-name": "string",
              "rt-type": "string",
              "adv-option": "string"
            }
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-GROUPS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/

Create operation of resource: af-groups

af-groups_schema

af-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "af-group": [
    {
      "af-group-name": "string",
      "af-group-afs": {
        "af-group-af": [
          {
            "af-name": "string",
            "create": [ null ],
            "af-group": "string",
            "advertise-vrf-imp-disable-v4": {
              "af-name": "string",
              "rt-type": "string",
              "adv-option": "string"
            }
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/

Delete operation of resource: af-groups

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/

Retrieve operation of resource: af-groups

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

af-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-group": [
    {
      "af-group-name": "string",
      "af-group-afs": {
        "af-group-af": [
          {
            "af-name": "string",
            "create": [ null ],
            "af-group": "string",
            "advertise-vrf-imp-disable-v4": {
              "af-name": "string",
              "rt-type": "string",
              "adv-option": "string"
            }
          }
        ]
      }
    }
  ]
}

AF-GROUP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/

Update operation of resource: af-group

af-group_schema

af-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

Request Content-Types: application/json

Request Example

{
  "af-group-name": "string",
  "af-group-afs": {
    "af-group-af": [
      {
        "af-name": "string",
        "create": [ null ],
        "af-group": "string",
        "advertise-vrf-imp-disable-v4": {
          "af-name": "string",
          "rt-type": "string",
          "adv-option": "string"
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-GROUP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/

Create operation of resource: af-group

af-group_schema

af-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

Request Content-Types: application/json

Request Example

{
  "af-group-name": "string",
  "af-group-afs": {
    "af-group-af": [
      {
        "af-name": "string",
        "create": [ null ],
        "af-group": "string",
        "advertise-vrf-imp-disable-v4": {
          "af-name": "string",
          "rt-type": "string",
          "adv-option": "string"
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/

Delete operation of resource: af-group

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/

Retrieve operation of resource: af-group

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

200 OK

af-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-group-name": "string",
  "af-group-afs": {
    "af-group-af": [
      {
        "af-name": "string",
        "create": [ null ],
        "af-group": "string",
        "advertise-vrf-imp-disable-v4": {
          "af-name": "string",
          "rt-type": "string",
          "adv-option": "string"
        }
      }
    ]
  }
}

AF-GROUP-AFS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/af-group-afs/

Update operation of resource: af-group-afs

af-group-afs_schema

af-group-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

Request Content-Types: application/json

Request Example

{
  "af-group-af": [
    {
      "af-name": "string",
      "create": [ null ],
      "af-group": "string",
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-GROUP-AFS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/af-group-afs/

Create operation of resource: af-group-afs

af-group-afs_schema

af-group-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

Request Content-Types: application/json

Request Example

{
  "af-group-af": [
    {
      "af-name": "string",
      "create": [ null ],
      "af-group": "string",
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-GROUP-AFS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/af-group-afs/

Delete operation of resource: af-group-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-GROUP-AFS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/af-group-afs/

Retrieve operation of resource: af-group-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

200 OK

af-group-afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-group-af": [
    {
      "af-name": "string",
      "create": [ null ],
      "af-group": "string",
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

AF-GROUP-AF - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/af-group-afs/af-group-af/{af-name}/

Update operation of resource: af-group-af

af-group-af_schema

af-group-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "create": [ null ],
  "af-group": "string",
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-GROUP-AF - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/af-group-afs/af-group-af/{af-name}/

Create operation of resource: af-group-af

af-group-af_schema

af-group-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "create": [ null ],
  "af-group": "string",
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-GROUP-AF - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/af-group-afs/af-group-af/{af-name}/

Delete operation of resource: af-group-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-GROUP-AF - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/af-group-afs/af-group-af/{af-name}/

Retrieve operation of resource: af-group-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

af-group-af_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "create": [ null ],
  "af-group": "string",
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

AIGP-COST-COMMUNITY - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/af-group-afs/af-group-af/{af-name}/aigp-cost-community/

Update operation of resource: aigp-cost-community

aigp-cost-community_schema

aigp-cost-communitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Create

Create operation of resource: aigp-cost-community

aigp-cost-community_schema

aigp-cost-communitybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Delete

Delete operation of resource: aigp-cost-community

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AIGP-COST-COMMUNITY - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/af-groups/af-group/{af-group-name}/af-group-afs/af-group-af/{af-name}/aigp-cost-community/

Retrieve operation of resource: aigp-cost-community

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

aigp-cost-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

ADVERTISE-DEF-IMP-DISABLE-V6 - Update

Update operation of resource: advertise-def-imp-disable-v6

advertise-def-imp-disable-v6_schema

advertise-def-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Create

Create operation of resource: advertise-def-imp-disable-v6

advertise-def-imp-disable-v6_schema

advertise-def-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Delete

Delete operation of resource: advertise-def-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V6 - Retrieve

Retrieve operation of resource: advertise-def-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-def-imp-disable-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-DISABLE - Update

Update operation of resource: advertise-disable

advertise-disable_schema

advertise-disablebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Create

Create operation of resource: advertise-disable

advertise-disable_schema

advertise-disablebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Delete

Delete operation of resource: advertise-disable

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DISABLE - Retrieve

Retrieve operation of resource: advertise-disable

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-disable_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

MAXIMUM-PREFIXES - Update

Update operation of resource: maximum-prefixes

maximum-prefixes_schema

maximum-prefixesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Create

Create operation of resource: maximum-prefixes

maximum-prefixes_schema

maximum-prefixesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Delete

Delete operation of resource: maximum-prefixes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-PREFIXES - Retrieve

Retrieve operation of resource: maximum-prefixes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

maximum-prefixes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Update

Update operation of resource: remove-private-as-entire-as-path-inbound

remove-private-as-entire-as-path-inbound_schema

remove-private-as-entire-as-path-inboundbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Create

Create operation of resource: remove-private-as-entire-as-path-inbound

remove-private-as-entire-as-path-inbound_schema

remove-private-as-entire-as-path-inboundbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Delete

Delete operation of resource: remove-private-as-entire-as-path-inbound

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND - Retrieve

Retrieve operation of resource: remove-private-as-entire-as-path-inbound

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

remove-private-as-entire-as-path-inbound_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "entire": "boolean",
  "enable": "boolean"
}

ADVERTISE-DEF-IMP-DISABLE-V4 - Update

Update operation of resource: advertise-def-imp-disable-v4

advertise-def-imp-disable-v4_schema

advertise-def-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Create

Create operation of resource: advertise-def-imp-disable-v4

advertise-def-imp-disable-v4_schema

advertise-def-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Delete

Delete operation of resource: advertise-def-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-DEF-IMP-DISABLE-V4 - Retrieve

Retrieve operation of resource: advertise-def-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-def-imp-disable-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-L2VPN-EVPN - Update

Update operation of resource: advertise-l2vpn-evpn

advertise-l2vpn-evpn_schema

advertise-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Create

Create operation of resource: advertise-l2vpn-evpn

advertise-l2vpn-evpn_schema

advertise-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Delete

Delete operation of resource: advertise-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-L2VPN-EVPN - Retrieve

Retrieve operation of resource: advertise-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-l2vpn-evpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-L2VPN-EVPN - Update

Update operation of resource: advertise-local-l2vpn-evpn

advertise-local-l2vpn-evpn_schema

advertise-local-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Create

Create operation of resource: advertise-local-l2vpn-evpn

advertise-local-l2vpn-evpn_schema

advertise-local-l2vpn-evpnbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Delete

Delete operation of resource: advertise-local-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-L2VPN-EVPN - Retrieve

Retrieve operation of resource: advertise-local-l2vpn-evpn

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-local-l2vpn-evpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Update

Update operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

neighbor-af-long-lived-graceful-restart-stale-time_schema

neighbor-af-long-lived-graceful-restart-stale-timebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Create

Create operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

neighbor-af-long-lived-graceful-restart-stale-time_schema

neighbor-af-long-lived-graceful-restart-stale-timebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Delete

Delete operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME - Retrieve

Retrieve operation of resource: neighbor-af-long-lived-graceful-restart-stale-time

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

neighbor-af-long-lived-graceful-restart-stale-time_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

SITE-OF-ORIGIN - Update

Update operation of resource: site-of-origin

site-of-origin_schema

site-of-originbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SITE-OF-ORIGIN - Create

Create operation of resource: site-of-origin

site-of-origin_schema

site-of-originbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SITE-OF-ORIGIN - Delete

Delete operation of resource: site-of-origin

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SITE-OF-ORIGIN - Retrieve

Retrieve operation of resource: site-of-origin

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

site-of-origin_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

ADVERTISE-V6 - Update

Update operation of resource: advertise-v6

advertise-v6_schema

advertise-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Create

Create operation of resource: advertise-v6

advertise-v6_schema

advertise-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Delete

Delete operation of resource: advertise-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V6 - Retrieve

Retrieve operation of resource: advertise-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-V6 - Update

Update operation of resource: advertise-local-v6

advertise-local-v6_schema

advertise-local-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Create

Create operation of resource: advertise-local-v6

advertise-local-v6_schema

advertise-local-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Delete

Delete operation of resource: advertise-local-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V6 - Retrieve

Retrieve operation of resource: advertise-local-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-local-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

IMPORT - Update

Update operation of resource: import

import_schema

importbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Create

Create operation of resource: import

import_schema

importbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Delete

Delete operation of resource: import

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT - Retrieve

Retrieve operation of resource: import

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

import_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

DEFAULT-ORIGINATE - Update

Update operation of resource: default-originate

default-originate_schema

default-originatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Create

Create operation of resource: default-originate

default-originate_schema

default-originatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "enable": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Delete

Delete operation of resource: default-originate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ORIGINATE - Retrieve

Retrieve operation of resource: default-originate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

default-originate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": "boolean",
  "route-policy-name": "string"
}

SOFT-RECONFIGURATION - Update

Update operation of resource: soft-reconfiguration

soft-reconfiguration_schema

soft-reconfigurationbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Create

Create operation of resource: soft-reconfiguration

soft-reconfiguration_schema

soft-reconfigurationbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Delete

Delete operation of resource: soft-reconfiguration

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOFT-RECONFIGURATION - Retrieve

Retrieve operation of resource: soft-reconfiguration

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

soft-reconfiguration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

ADVERTISE-VRF-IMP-DISABLE-V6 - Update

Update operation of resource: advertise-vrf-imp-disable-v6

advertise-vrf-imp-disable-v6_schema

advertise-vrf-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Create

Create operation of resource: advertise-vrf-imp-disable-v6

advertise-vrf-imp-disable-v6_schema

advertise-vrf-imp-disable-v6body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Delete

Delete operation of resource: advertise-vrf-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V6 - Retrieve

Retrieve operation of resource: advertise-vrf-imp-disable-v6

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-vrf-imp-disable-v6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

ADVERTISE-V4 - Update

Update operation of resource: advertise-v4

advertise-v4_schema

advertise-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Create

Create operation of resource: advertise-v4

advertise-v4_schema

advertise-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Delete

Delete operation of resource: advertise-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-V4 - Retrieve

Retrieve operation of resource: advertise-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

ADVERTISE-LOCAL-V4 - Update

Update operation of resource: advertise-local-v4

advertise-local-v4_schema

advertise-local-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Create

Create operation of resource: advertise-local-v4

advertise-local-v4_schema

advertise-local-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Delete

Delete operation of resource: advertise-local-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-LOCAL-V4 - Retrieve

Retrieve operation of resource: advertise-local-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-local-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Update

Update operation of resource: remove-private-as-entire-as-path

remove-private-as-entire-as-path_schema

remove-private-as-entire-as-pathbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Create

Create operation of resource: remove-private-as-entire-as-path

remove-private-as-entire-as-path_schema

remove-private-as-entire-as-pathbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "entire": "boolean",
  "enable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Delete

Delete operation of resource: remove-private-as-entire-as-path

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH - Retrieve

Retrieve operation of resource: remove-private-as-entire-as-path

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

remove-private-as-entire-as-path_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "entire": "boolean",
  "enable": "boolean"
}

ADVERTISE-VRF-IMP-DISABLE-V4 - Update

Update operation of resource: advertise-vrf-imp-disable-v4

advertise-vrf-imp-disable-v4_schema

advertise-vrf-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Create

Create operation of resource: advertise-vrf-imp-disable-v4

advertise-vrf-imp-disable-v4_schema

advertise-vrf-imp-disable-v4body object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Delete

Delete operation of resource: advertise-vrf-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-VRF-IMP-DISABLE-V4 - Retrieve

Retrieve operation of resource: advertise-vrf-imp-disable-v4

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-group-name

in path

string

ID of af-group-name

af-name

in path

string

ID of af-name

200 OK

advertise-vrf-imp-disable-v4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

SESSION-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/

Update operation of resource: session-groups

session-groups_schema

session-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "session-group": [
    {
      "session-group-name": "string",
      "session-group-add-member": "string",
      "graceful-maintenance": {
        "enable": [ null ],
        "graceful-maintenance-local-preference": {
          "local-preference": "integer",
          "gshut-loc-pref-disable": "boolean"
        },
        "graceful-maintenance-activate": "boolean",
        "graceful-maintenance-as-prepends": {
          "gshut-prepends-disable": "boolean",
          "as-prepends": "integer"
        }
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION-GROUPS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/

Create operation of resource: session-groups

session-groups_schema

session-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "session-group": [
    {
      "session-group-name": "string",
      "session-group-add-member": "string",
      "graceful-maintenance": {
        "enable": [ null ],
        "graceful-maintenance-local-preference": {
          "local-preference": "integer",
          "gshut-loc-pref-disable": "boolean"
        },
        "graceful-maintenance-activate": "boolean",
        "graceful-maintenance-as-prepends": {
          "gshut-prepends-disable": "boolean",
          "as-prepends": "integer"
        }
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/

Delete operation of resource: session-groups

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/

Retrieve operation of resource: session-groups

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

session-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "session-group": [
    {
      "session-group-name": "string",
      "session-group-add-member": "string",
      "graceful-maintenance": {
        "enable": [ null ],
        "graceful-maintenance-local-preference": {
          "local-preference": "integer",
          "gshut-loc-pref-disable": "boolean"
        },
        "graceful-maintenance-activate": "boolean",
        "graceful-maintenance-as-prepends": {
          "gshut-prepends-disable": "boolean",
          "as-prepends": "integer"
        }
      }
    }
  ]
}

SESSION-GROUP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/

Update operation of resource: session-group

session-group_schema

session-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "session-group-name": "string",
  "session-group-add-member": "string",
  "graceful-maintenance": {
    "enable": [ null ],
    "graceful-maintenance-local-preference": {
      "local-preference": "integer",
      "gshut-loc-pref-disable": "boolean"
    },
    "graceful-maintenance-activate": "boolean",
    "graceful-maintenance-as-prepends": {
      "gshut-prepends-disable": "boolean",
      "as-prepends": "integer"
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION-GROUP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/

Create operation of resource: session-group

session-group_schema

session-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "session-group-name": "string",
  "session-group-add-member": "string",
  "graceful-maintenance": {
    "enable": [ null ],
    "graceful-maintenance-local-preference": {
      "local-preference": "integer",
      "gshut-loc-pref-disable": "boolean"
    },
    "graceful-maintenance-activate": "boolean",
    "graceful-maintenance-as-prepends": {
      "gshut-prepends-disable": "boolean",
      "as-prepends": "integer"
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/

Delete operation of resource: session-group

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/

Retrieve operation of resource: session-group

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

session-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "session-group-name": "string",
  "session-group-add-member": "string",
  "graceful-maintenance": {
    "enable": [ null ],
    "graceful-maintenance-local-preference": {
      "local-preference": "integer",
      "gshut-loc-pref-disable": "boolean"
    },
    "graceful-maintenance-activate": "boolean",
    "graceful-maintenance-as-prepends": {
      "gshut-prepends-disable": "boolean",
      "as-prepends": "integer"
    }
  }
}

LOCAL-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/local-address/

Update operation of resource: local-address

local-address_schema

local-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/local-address/

Create operation of resource: local-address

local-address_schema

local-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/local-address/

Delete operation of resource: local-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/local-address/

Retrieve operation of resource: local-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

local-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

BMP-ACTIVATES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/bmp-activates/

Update operation of resource: bmp-activates

bmp-activates_schema

bmp-activatesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/bmp-activates/

Create operation of resource: bmp-activates

bmp-activates_schema

bmp-activatesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/bmp-activates/

Delete operation of resource: bmp-activates

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/bmp-activates/

Retrieve operation of resource: bmp-activates

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

bmp-activates_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

BMP-ACTIVATE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/bmp-activates/bmp-activate/{server-id}/

Update operation of resource: bmp-activate

bmp-activate_schema

bmp-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "server-id": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/bmp-activates/bmp-activate/{server-id}/

Create operation of resource: bmp-activate

bmp-activate_schema

bmp-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "server-id": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/bmp-activates/bmp-activate/{server-id}/

Delete operation of resource: bmp-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

server-id

in path

string

ID of server-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-ACTIVATE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/bmp-activates/bmp-activate/{server-id}/

Retrieve operation of resource: bmp-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

server-id

in path

string

ID of server-id

200 OK

bmp-activate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "server-id": "integer"
}

EBGP-MULTIHOP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/ebgp-multihop/

Update operation of resource: ebgp-multihop

ebgp-multihop_schema

ebgp-multihopbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/ebgp-multihop/

Create operation of resource: ebgp-multihop

ebgp-multihop_schema

ebgp-multihopbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/ebgp-multihop/

Delete operation of resource: ebgp-multihop

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP-MULTIHOP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/ebgp-multihop/

Retrieve operation of resource: ebgp-multihop

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

ebgp-multihop_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

REMOTE-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/remote-as/

Update operation of resource: remote-as

remote-as_schema

remote-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/remote-as/

Create operation of resource: remote-as

remote-as_schema

remote-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/remote-as/

Delete operation of resource: remote-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/remote-as/

Retrieve operation of resource: remote-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

remote-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-xx": "string",
  "as-yy": "string"
}

LOCAL-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/local-as/

Update operation of resource: local-as

local-as_schema

local-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/local-as/

Create operation of resource: local-as

local-as_schema

local-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/local-as/

Delete operation of resource: local-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/local-as/

Retrieve operation of resource: local-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

local-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

PASSWORD - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/password/

Update operation of resource: password

password_schema

passwordbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "password-disable": "boolean",
  "password": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/password/

Create operation of resource: password

password_schema

passwordbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "password-disable": "boolean",
  "password": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/password/

Delete operation of resource: password

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/password/

Retrieve operation of resource: password

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

password_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "password-disable": "boolean",
  "password": "string"
}

ADVERTISEMENT-INTERVAL - Update

Update operation of resource: advertisement-interval

advertisement-interval_schema

advertisement-intervalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Create

Create operation of resource: advertisement-interval

advertisement-interval_schema

advertisement-intervalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Delete

Delete operation of resource: advertisement-interval

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISEMENT-INTERVAL - Retrieve

Retrieve operation of resource: advertisement-interval

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

advertisement-interval_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

NEIGHBOR-CLUSTER-ID - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/neighbor-cluster-id/

Update operation of resource: neighbor-cluster-id

neighbor-cluster-id_schema

neighbor-cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Create

Create operation of resource: neighbor-cluster-id

neighbor-cluster-id_schema

neighbor-cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Delete

Delete operation of resource: neighbor-cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-CLUSTER-ID - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/neighbor-cluster-id/

Retrieve operation of resource: neighbor-cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

neighbor-cluster-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

TCPMSS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/tcpmss/

Update operation of resource: tcpmss

tcpmss_schema

tcpmssbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/tcpmss/

Create operation of resource: tcpmss

tcpmss_schema

tcpmssbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/tcpmss/

Delete operation of resource: tcpmss

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TCPMSS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/tcpmss/

Retrieve operation of resource: tcpmss

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

tcpmss_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

TOS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/tos/

Update operation of resource: tos

tos_schema

tosbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/tos/

Create operation of resource: tos

tos_schema

tosbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/tos/

Delete operation of resource: tos

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/tos/

Retrieve operation of resource: tos

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "type": "string",
  "value": "string"
}

UPDATE-IN-FILTERING - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/update-in-filtering/

Update operation of resource: update-in-filtering

update-in-filtering_schema

update-in-filteringbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Create

Create operation of resource: update-in-filtering

update-in-filtering_schema

update-in-filteringbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Delete

Delete operation of resource: update-in-filtering

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/update-in-filtering/

Retrieve operation of resource: update-in-filtering

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

update-in-filtering_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Update

Update operation of resource: update-in-filtering-message-buffers

update-in-filtering-message-buffers_schema

update-in-filtering-message-buffersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Create

Create operation of resource: update-in-filtering-message-buffers

update-in-filtering-message-buffers_schema

update-in-filtering-message-buffersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Delete

Delete operation of resource: update-in-filtering-message-buffers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-IN-FILTERING-MESSAGE-BUFFERS - Retrieve

Retrieve operation of resource: update-in-filtering-message-buffers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

update-in-filtering-message-buffers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

MSG-LOG-OUT - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/msg-log-out/

Update operation of resource: msg-log-out

msg-log-out_schema

msg-log-outbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/msg-log-out/

Create operation of resource: msg-log-out

msg-log-out_schema

msg-log-outbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/msg-log-out/

Delete operation of resource: msg-log-out

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-OUT - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/msg-log-out/

Retrieve operation of resource: msg-log-out

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

msg-log-out_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

AO-KEYCHAIN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/ao-keychain/

Update operation of resource: ao-keychain

ao-keychain_schema

ao-keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/ao-keychain/

Create operation of resource: ao-keychain

ao-keychain_schema

ao-keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/ao-keychain/

Delete operation of resource: ao-keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AO-KEYCHAIN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/ao-keychain/

Retrieve operation of resource: ao-keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

ao-keychain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

RECEIVE-BUFFER-SIZE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/receive-buffer-size/

Update operation of resource: receive-buffer-size

receive-buffer-size_schema

receive-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Create

Create operation of resource: receive-buffer-size

receive-buffer-size_schema

receive-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Delete

Delete operation of resource: receive-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-BUFFER-SIZE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/receive-buffer-size/

Retrieve operation of resource: receive-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

receive-buffer-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

MSG-LOG-IN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/msg-log-in/

Update operation of resource: msg-log-in

msg-log-in_schema

msg-log-inbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/msg-log-in/

Create operation of resource: msg-log-in

msg-log-in_schema

msg-log-inbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/msg-log-in/

Delete operation of resource: msg-log-in

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MSG-LOG-IN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/msg-log-in/

Retrieve operation of resource: msg-log-in

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

msg-log-in_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

SEND-BUFFER-SIZE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/send-buffer-size/

Update operation of resource: send-buffer-size

send-buffer-size_schema

send-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/send-buffer-size/

Create operation of resource: send-buffer-size

send-buffer-size_schema

send-buffer-sizebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/send-buffer-size/

Delete operation of resource: send-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-BUFFER-SIZE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/send-buffer-size/

Retrieve operation of resource: send-buffer-size

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

send-buffer-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

TIMERS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/timers/

Update operation of resource: timers

timers_schema

timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/timers/

Create operation of resource: timers

timers_schema

timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/timers/

Delete operation of resource: timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMERS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/timers/

Retrieve operation of resource: timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

timers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

KEYCHAIN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/keychain/

Update operation of resource: keychain

keychain_schema

keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/keychain/

Create operation of resource: keychain

keychain_schema

keychainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/keychain/

Delete operation of resource: keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEYCHAIN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/bgp-entity/session-groups/session-group/{session-group-name}/keychain/

Retrieve operation of resource: keychain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

keychain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

GRACEFUL-MAINTENANCE - Update

Update operation of resource: graceful-maintenance

graceful-maintenance_schema

graceful-maintenancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Create

Create operation of resource: graceful-maintenance

graceful-maintenance_schema

graceful-maintenancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Delete

Delete operation of resource: graceful-maintenance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE - Retrieve

Retrieve operation of resource: graceful-maintenance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

graceful-maintenance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Update

Update operation of resource: graceful-maintenance-local-preference

graceful-maintenance-local-preference_schema

graceful-maintenance-local-preferencebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Create

Create operation of resource: graceful-maintenance-local-preference

graceful-maintenance-local-preference_schema

graceful-maintenance-local-preferencebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Delete

Delete operation of resource: graceful-maintenance-local-preference

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-LOCAL-PREFERENCE - Retrieve

Retrieve operation of resource: graceful-maintenance-local-preference

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

graceful-maintenance-local-preference_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

GRACEFUL-MAINTENANCE-AS-PREPENDS - Update

Update operation of resource: graceful-maintenance-as-prepends

graceful-maintenance-as-prepends_schema

graceful-maintenance-as-prependsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Create

Create operation of resource: graceful-maintenance-as-prepends

graceful-maintenance-as-prepends_schema

graceful-maintenance-as-prependsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

Request Content-Types: application/json

Request Example

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Delete

Delete operation of resource: graceful-maintenance-as-prepends

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-MAINTENANCE-AS-PREPENDS - Retrieve

Retrieve operation of resource: graceful-maintenance-as-prepends

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

session-group-name

in path

string

ID of session-group-name

200 OK

graceful-maintenance-as-prepends_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

GLOBAL - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/

Update operation of resource: global

global_schema

globalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "mvpn": [ null ],
  "rpki-origin-as-validation-disable": [ null ],
  "rpki-static-routes": {
    "rpki-static-route": [
      {
        "addrress": "string",
        "as": "integer",
        "minimum": "integer",
        "maximum": "integer"
      }
    ]
  },
  "update-error-handling-extended-ibgp": [ null ],
  "install-diversion": [ null ],
  "attribute-filter-groups": {
    "attribute-filter-group": [
      {
        "enable": [ null ],
        "attribute-filter-group-name": "string",
        "attribute-filters": {
          "attribute-filter": [
            {
              "attribute-start": "string",
              "attribute-end": "string",
              "filter-action": "string"
            }
          ]
        }
      }
    ]
  },
  "update-limit-process": "integer",
  "rpki-origin-as-validation-time": "integer",
  "nsr": "boolean",
  "read-only": [ null ],
  "graceful-restart-stalepath-time": "integer",
  "graceful-reset": [ null ],
  "update-out-logging": [ null ],
  "graceful-restart-time": "integer",
  "confederation-domain": {
    "as-xx": "string",
    "as-yy": "string"
  },
  "global-graceful-maintenance-activate": {
    "retain-routes": "boolean",
    "all-neighbors": "boolean"
  },
  "graceful-restart-purge-time": "integer",
  "confederation-peer-ases": {
    "confederation-peer-as": [
      {
        "as-xx": "string",
        "as-yy": "string"
      }
    ]
  },
  "update-error-handling-basic-ebgp-disable": [ null ],
  "igp-loop-check": [ null ],
  "write-limit": {
    "formatted-messages": "integer",
    "desynchronize": "boolean",
    "enqueued-messages": "integer"
  },
  "rpki-bestpath-use-origin-as-validity": [ null ],
  "cluster-id": {
    "cluster-id-number": "integer",
    "cluster-id-address": "string"
  },
  "as-league": {
    "peers": {
      "peer": [
        {
          "as-xx": "string",
          "as-yy": "string"
        }
      ]
    },
    "enable": [ null ]
  },
  "enforce-ibgp-out-policy": [ null ],
  "rpki-servers": {
    "rpki-server": [
      {
        "username": "string",
        "password": "string",
        "enable": [ null ],
        "response-time": "integer",
        "refresh-time": "integer",
        "server": "string",
        "shutdown": [ null ],
        "purge-time": "integer",
        "transport": {
          "port": "string",
          "transport": "string"
        }
      }
    ]
  },
  "update-delay": {
    "delay": "integer",
    "always": "boolean"
  },
  "update-error-handling-basic-ibgp-disable": [ null ],
  "next-hop-trigger-delay": "integer",
  "as-list-groups": {
    "as-list-group": [
      {
        "ases": {
          "as": [
            {
              "as-xx": "string",
              "as-yy": "string"
            }
          ]
        },
        "enable": [ null ],
        "as-list-group-name": "string"
      }
    ]
  },
  "limits": {
    "maximum-neighbors": "integer"
  },
  "rpki-bestpath-origin-as-allow-invalid": [ null ],
  "global-afs": {
    "global-af": [
      null
    ]
  },
  "local-preference": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/

Create operation of resource: global

global_schema

globalbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "mvpn": [ null ],
  "rpki-origin-as-validation-disable": [ null ],
  "rpki-static-routes": {
    "rpki-static-route": [
      {
        "addrress": "string",
        "as": "integer",
        "minimum": "integer",
        "maximum": "integer"
      }
    ]
  },
  "update-error-handling-extended-ibgp": [ null ],
  "install-diversion": [ null ],
  "attribute-filter-groups": {
    "attribute-filter-group": [
      {
        "enable": [ null ],
        "attribute-filter-group-name": "string",
        "attribute-filters": {
          "attribute-filter": [
            {
              "attribute-start": "string",
              "attribute-end": "string",
              "filter-action": "string"
            }
          ]
        }
      }
    ]
  },
  "update-limit-process": "integer",
  "rpki-origin-as-validation-time": "integer",
  "nsr": "boolean",
  "read-only": [ null ],
  "graceful-restart-stalepath-time": "integer",
  "graceful-reset": [ null ],
  "update-out-logging": [ null ],
  "graceful-restart-time": "integer",
  "confederation-domain": {
    "as-xx": "string",
    "as-yy": "string"
  },
  "global-graceful-maintenance-activate": {
    "retain-routes": "boolean",
    "all-neighbors": "boolean"
  },
  "graceful-restart-purge-time": "integer",
  "confederation-peer-ases": {
    "confederation-peer-as": [
      {
        "as-xx": "string",
        "as-yy": "string"
      }
    ]
  },
  "update-error-handling-basic-ebgp-disable": [ null ],
  "igp-loop-check": [ null ],
  "write-limit": {
    "formatted-messages": "integer",
    "desynchronize": "boolean",
    "enqueued-messages": "integer"
  },
  "rpki-bestpath-use-origin-as-validity": [ null ],
  "cluster-id": {
    "cluster-id-number": "integer",
    "cluster-id-address": "string"
  },
  "as-league": {
    "peers": {
      "peer": [
        {
          "as-xx": "string",
          "as-yy": "string"
        }
      ]
    },
    "enable": [ null ]
  },
  "enforce-ibgp-out-policy": [ null ],
  "rpki-servers": {
    "rpki-server": [
      {
        "username": "string",
        "password": "string",
        "enable": [ null ],
        "response-time": "integer",
        "refresh-time": "integer",
        "server": "string",
        "shutdown": [ null ],
        "purge-time": "integer",
        "transport": {
          "port": "string",
          "transport": "string"
        }
      }
    ]
  },
  "update-delay": {
    "delay": "integer",
    "always": "boolean"
  },
  "update-error-handling-basic-ibgp-disable": [ null ],
  "next-hop-trigger-delay": "integer",
  "as-list-groups": {
    "as-list-group": [
      {
        "ases": {
          "as": [
            {
              "as-xx": "string",
              "as-yy": "string"
            }
          ]
        },
        "enable": [ null ],
        "as-list-group-name": "string"
      }
    ]
  },
  "limits": {
    "maximum-neighbors": "integer"
  },
  "rpki-bestpath-origin-as-allow-invalid": [ null ],
  "global-afs": {
    "global-af": [
      null
    ]
  },
  "local-preference": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/

Delete operation of resource: global

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/

Retrieve operation of resource: global

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

global_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "mvpn": [ null ],
  "rpki-origin-as-validation-disable": [ null ],
  "rpki-static-routes": {
    "rpki-static-route": [
      {
        "addrress": "string",
        "as": "integer",
        "minimum": "integer",
        "maximum": "integer"
      }
    ]
  },
  "update-error-handling-extended-ibgp": [ null ],
  "install-diversion": [ null ],
  "attribute-filter-groups": {
    "attribute-filter-group": [
      {
        "enable": [ null ],
        "attribute-filter-group-name": "string",
        "attribute-filters": {
          "attribute-filter": [
            {
              "attribute-start": "string",
              "attribute-end": "string",
              "filter-action": "string"
            }
          ]
        }
      }
    ]
  },
  "update-limit-process": "integer",
  "rpki-origin-as-validation-time": "integer",
  "nsr": "boolean",
  "read-only": [ null ],
  "graceful-restart-stalepath-time": "integer",
  "graceful-reset": [ null ],
  "update-out-logging": [ null ],
  "graceful-restart-time": "integer",
  "confederation-domain": {
    "as-xx": "string",
    "as-yy": "string"
  },
  "global-graceful-maintenance-activate": {
    "retain-routes": "boolean",
    "all-neighbors": "boolean"
  },
  "graceful-restart-purge-time": "integer",
  "confederation-peer-ases": {
    "confederation-peer-as": [
      {
        "as-xx": "string",
        "as-yy": "string"
      }
    ]
  },
  "update-error-handling-basic-ebgp-disable": [ null ],
  "igp-loop-check": [ null ],
  "write-limit": {
    "formatted-messages": "integer",
    "desynchronize": "boolean",
    "enqueued-messages": "integer"
  },
  "rpki-bestpath-use-origin-as-validity": [ null ],
  "cluster-id": {
    "cluster-id-number": "integer",
    "cluster-id-address": "string"
  },
  "as-league": {
    "peers": {
      "peer": [
        {
          "as-xx": "string",
          "as-yy": "string"
        }
      ]
    },
    "enable": [ null ]
  },
  "enforce-ibgp-out-policy": [ null ],
  "rpki-servers": {
    "rpki-server": [
      {
        "username": "string",
        "password": "string",
        "enable": [ null ],
        "response-time": "integer",
        "refresh-time": "integer",
        "server": "string",
        "shutdown": [ null ],
        "purge-time": "integer",
        "transport": {
          "port": "string",
          "transport": "string"
        }
      }
    ]
  },
  "update-delay": {
    "delay": "integer",
    "always": "boolean"
  },
  "update-error-handling-basic-ibgp-disable": [ null ],
  "next-hop-trigger-delay": "integer",
  "as-list-groups": {
    "as-list-group": [
      {
        "ases": {
          "as": [
            {
              "as-xx": "string",
              "as-yy": "string"
            }
          ]
        },
        "enable": [ null ],
        "as-list-group-name": "string"
      }
    ]
  },
  "limits": {
    "maximum-neighbors": "integer"
  },
  "rpki-bestpath-origin-as-allow-invalid": [ null ],
  "global-afs": {
    "global-af": [
      null
    ]
  },
  "local-preference": "integer"
}

CLUSTER-ID - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/cluster-id/

Update operation of resource: cluster-id

cluster-id_schema

cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLUSTER-ID - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/cluster-id/

Create operation of resource: cluster-id

cluster-id_schema

cluster-idbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLUSTER-ID - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/cluster-id/

Delete operation of resource: cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLUSTER-ID - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/cluster-id/

Retrieve operation of resource: cluster-id

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

cluster-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

WRITE-LIMIT - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/write-limit/

Update operation of resource: write-limit

write-limit_schema

write-limitbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "formatted-messages": "integer",
  "desynchronize": "boolean",
  "enqueued-messages": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WRITE-LIMIT - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/write-limit/

Create operation of resource: write-limit

write-limit_schema

write-limitbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "formatted-messages": "integer",
  "desynchronize": "boolean",
  "enqueued-messages": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WRITE-LIMIT - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/write-limit/

Delete operation of resource: write-limit

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

WRITE-LIMIT - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/write-limit/

Retrieve operation of resource: write-limit

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

write-limit_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "formatted-messages": "integer",
  "desynchronize": "boolean",
  "enqueued-messages": "integer"
}

UPDATE-DELAY - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/update-delay/

Update operation of resource: update-delay

update-delay_schema

update-delaybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "delay": "integer",
  "always": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-DELAY - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/update-delay/

Create operation of resource: update-delay

update-delay_schema

update-delaybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "delay": "integer",
  "always": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-DELAY - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/update-delay/

Delete operation of resource: update-delay

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UPDATE-DELAY - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/update-delay/

Retrieve operation of resource: update-delay

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

update-delay_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "delay": "integer",
  "always": "boolean"
}

AS-LEAGUE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-league/

Update operation of resource: as-league

as-league_schema

as-leaguebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "peers": {
    "peer": [
      {
        "as-xx": "string",
        "as-yy": "string"
      }
    ]
  },
  "enable": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS-LEAGUE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-league/

Create operation of resource: as-league

as-league_schema

as-leaguebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "peers": {
    "peer": [
      {
        "as-xx": "string",
        "as-yy": "string"
      }
    ]
  },
  "enable": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS-LEAGUE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-league/

Delete operation of resource: as-league

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS-LEAGUE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-league/

Retrieve operation of resource: as-league

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

as-league_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "peers": {
    "peer": [
      {
        "as-xx": "string",
        "as-yy": "string"
      }
    ]
  },
  "enable": [ null ]
}

PEERS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-league/peers/

Update operation of resource: peers

peers_schema

peersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "peer": [
    {
      "as-xx": "string",
      "as-yy": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEERS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-league/peers/

Create operation of resource: peers

peers_schema

peersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "peer": [
    {
      "as-xx": "string",
      "as-yy": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEERS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-league/peers/

Delete operation of resource: peers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEERS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-league/peers/

Retrieve operation of resource: peers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

peers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "peer": [
    {
      "as-xx": "string",
      "as-yy": "string"
    }
  ]
}

PEER - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-league/peers/peer/{as-xx as-yy}/

Update operation of resource: peer

peer_schema

peerbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-xx as-yy

in path

string

ID of as-xx as-yy

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-league/peers/peer/{as-xx as-yy}/

Create operation of resource: peer

peer_schema

peerbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-xx as-yy

in path

string

ID of as-xx as-yy

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-league/peers/peer/{as-xx as-yy}/

Delete operation of resource: peer

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-xx as-yy

in path

string

ID of as-xx as-yy

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-league/peers/peer/{as-xx as-yy}/

Retrieve operation of resource: peer

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-xx as-yy

in path

string

ID of as-xx as-yy

200 OK

peer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-xx": "string",
  "as-yy": "string"
}

RPKI-SERVERS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-servers/

Update operation of resource: rpki-servers

rpki-servers_schema

rpki-serversbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "rpki-server": [
    {
      "username": "string",
      "password": "string",
      "enable": [ null ],
      "response-time": "integer",
      "refresh-time": "integer",
      "server": "string",
      "shutdown": [ null ],
      "purge-time": "integer",
      "transport": {
        "port": "string",
        "transport": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPKI-SERVERS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-servers/

Create operation of resource: rpki-servers

rpki-servers_schema

rpki-serversbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "rpki-server": [
    {
      "username": "string",
      "password": "string",
      "enable": [ null ],
      "response-time": "integer",
      "refresh-time": "integer",
      "server": "string",
      "shutdown": [ null ],
      "purge-time": "integer",
      "transport": {
        "port": "string",
        "transport": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPKI-SERVERS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-servers/

Delete operation of resource: rpki-servers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPKI-SERVERS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-servers/

Retrieve operation of resource: rpki-servers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

rpki-servers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "rpki-server": [
    {
      "username": "string",
      "password": "string",
      "enable": [ null ],
      "response-time": "integer",
      "refresh-time": "integer",
      "server": "string",
      "shutdown": [ null ],
      "purge-time": "integer",
      "transport": {
        "port": "string",
        "transport": "string"
      }
    }
  ]
}

RPKI-SERVER - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-servers/rpki-server/{server}/

Update operation of resource: rpki-server

rpki-server_schema

rpki-serverbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

server

in path

string

ID of server

Request Content-Types: application/json

Request Example

{
  "username": "string",
  "password": "string",
  "enable": [ null ],
  "response-time": "integer",
  "refresh-time": "integer",
  "server": "string",
  "shutdown": [ null ],
  "purge-time": "integer",
  "transport": {
    "port": "string",
    "transport": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPKI-SERVER - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-servers/rpki-server/{server}/

Create operation of resource: rpki-server

rpki-server_schema

rpki-serverbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

server

in path

string

ID of server

Request Content-Types: application/json

Request Example

{
  "username": "string",
  "password": "string",
  "enable": [ null ],
  "response-time": "integer",
  "refresh-time": "integer",
  "server": "string",
  "shutdown": [ null ],
  "purge-time": "integer",
  "transport": {
    "port": "string",
    "transport": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPKI-SERVER - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-servers/rpki-server/{server}/

Delete operation of resource: rpki-server

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

server

in path

string

ID of server

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPKI-SERVER - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-servers/rpki-server/{server}/

Retrieve operation of resource: rpki-server

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

server

in path

string

ID of server

200 OK

rpki-server_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "username": "string",
  "password": "string",
  "enable": [ null ],
  "response-time": "integer",
  "refresh-time": "integer",
  "server": "string",
  "shutdown": [ null ],
  "purge-time": "integer",
  "transport": {
    "port": "string",
    "transport": "string"
  }
}

TRANSPORT - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-servers/rpki-server/{server}/transport/

Update operation of resource: transport

transport_schema

transportbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

server

in path

string

ID of server

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "transport": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSPORT - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-servers/rpki-server/{server}/transport/

Create operation of resource: transport

transport_schema

transportbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

server

in path

string

ID of server

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "transport": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSPORT - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-servers/rpki-server/{server}/transport/

Delete operation of resource: transport

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

server

in path

string

ID of server

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSPORT - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-servers/rpki-server/{server}/transport/

Retrieve operation of resource: transport

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

server

in path

string

ID of server

200 OK

transport_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "port": "string",
  "transport": "string"
}

AS-LIST-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/

Update operation of resource: as-list-groups

as-list-groups_schema

as-list-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "as-list-group": [
    {
      "ases": {
        "as": [
          {
            "as-xx": "string",
            "as-yy": "string"
          }
        ]
      },
      "enable": [ null ],
      "as-list-group-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS-LIST-GROUPS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/

Create operation of resource: as-list-groups

as-list-groups_schema

as-list-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "as-list-group": [
    {
      "ases": {
        "as": [
          {
            "as-xx": "string",
            "as-yy": "string"
          }
        ]
      },
      "enable": [ null ],
      "as-list-group-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS-LIST-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/

Delete operation of resource: as-list-groups

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS-LIST-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/

Retrieve operation of resource: as-list-groups

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

as-list-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-list-group": [
    {
      "ases": {
        "as": [
          {
            "as-xx": "string",
            "as-yy": "string"
          }
        ]
      },
      "enable": [ null ],
      "as-list-group-name": "string"
    }
  ]
}

AS-LIST-GROUP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/as-list-group/{as-list-group-name}/

Update operation of resource: as-list-group

as-list-group_schema

as-list-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-list-group-name

in path

string

ID of as-list-group-name

Request Content-Types: application/json

Request Example

{
  "ases": {
    "as": [
      {
        "as-xx": "string",
        "as-yy": "string"
      }
    ]
  },
  "enable": [ null ],
  "as-list-group-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS-LIST-GROUP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/as-list-group/{as-list-group-name}/

Create operation of resource: as-list-group

as-list-group_schema

as-list-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-list-group-name

in path

string

ID of as-list-group-name

Request Content-Types: application/json

Request Example

{
  "ases": {
    "as": [
      {
        "as-xx": "string",
        "as-yy": "string"
      }
    ]
  },
  "enable": [ null ],
  "as-list-group-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS-LIST-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/as-list-group/{as-list-group-name}/

Delete operation of resource: as-list-group

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-list-group-name

in path

string

ID of as-list-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS-LIST-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/as-list-group/{as-list-group-name}/

Retrieve operation of resource: as-list-group

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-list-group-name

in path

string

ID of as-list-group-name

200 OK

as-list-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "ases": {
    "as": [
      {
        "as-xx": "string",
        "as-yy": "string"
      }
    ]
  },
  "enable": [ null ],
  "as-list-group-name": "string"
}

ASES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/as-list-group/{as-list-group-name}/ases/

Update operation of resource: ases

ases_schema

asesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-list-group-name

in path

string

ID of as-list-group-name

Request Content-Types: application/json

Request Example

{
  "as": [
    {
      "as-xx": "string",
      "as-yy": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ASES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/as-list-group/{as-list-group-name}/ases/

Create operation of resource: ases

ases_schema

asesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-list-group-name

in path

string

ID of as-list-group-name

Request Content-Types: application/json

Request Example

{
  "as": [
    {
      "as-xx": "string",
      "as-yy": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ASES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/as-list-group/{as-list-group-name}/ases/

Delete operation of resource: ases

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-list-group-name

in path

string

ID of as-list-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ASES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/as-list-group/{as-list-group-name}/ases/

Retrieve operation of resource: ases

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-list-group-name

in path

string

ID of as-list-group-name

200 OK

ases_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as": [
    {
      "as-xx": "string",
      "as-yy": "string"
    }
  ]
}

AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/as-list-group/{as-list-group-name}/ases/as/{as-xx as-yy}/

Update operation of resource: as

as_schema

asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-list-group-name

in path

string

ID of as-list-group-name

as-xx as-yy

in path

string

ID of as-xx as-yy

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/as-list-group/{as-list-group-name}/ases/as/{as-xx as-yy}/

Create operation of resource: as

as_schema

asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-list-group-name

in path

string

ID of as-list-group-name

as-xx as-yy

in path

string

ID of as-xx as-yy

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/as-list-group/{as-list-group-name}/ases/as/{as-xx as-yy}/

Delete operation of resource: as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-list-group-name

in path

string

ID of as-list-group-name

as-xx as-yy

in path

string

ID of as-xx as-yy

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/as-list-groups/as-list-group/{as-list-group-name}/ases/as/{as-xx as-yy}/

Retrieve operation of resource: as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-list-group-name

in path

string

ID of as-list-group-name

as-xx as-yy

in path

string

ID of as-xx as-yy

200 OK

as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-xx": "string",
  "as-yy": "string"
}

LIMITS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/limits/

Update operation of resource: limits

limits_schema

limitsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "maximum-neighbors": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIMITS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/limits/

Create operation of resource: limits

limits_schema

limitsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "maximum-neighbors": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIMITS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/limits/

Delete operation of resource: limits

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIMITS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/limits/

Retrieve operation of resource: limits

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

limits_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "maximum-neighbors": "integer"
}

CONFEDERATION-DOMAIN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/confederation-domain/

Update operation of resource: confederation-domain

confederation-domain_schema

confederation-domainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONFEDERATION-DOMAIN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/confederation-domain/

Create operation of resource: confederation-domain

confederation-domain_schema

confederation-domainbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONFEDERATION-DOMAIN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/confederation-domain/

Delete operation of resource: confederation-domain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONFEDERATION-DOMAIN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/confederation-domain/

Retrieve operation of resource: confederation-domain

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

confederation-domain_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-xx": "string",
  "as-yy": "string"
}

CONFEDERATION-PEER-ASES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/confederation-peer-ases/

Update operation of resource: confederation-peer-ases

confederation-peer-ases_schema

confederation-peer-asesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "confederation-peer-as": [
    {
      "as-xx": "string",
      "as-yy": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONFEDERATION-PEER-ASES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/confederation-peer-ases/

Create operation of resource: confederation-peer-ases

confederation-peer-ases_schema

confederation-peer-asesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "confederation-peer-as": [
    {
      "as-xx": "string",
      "as-yy": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONFEDERATION-PEER-ASES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/confederation-peer-ases/

Delete operation of resource: confederation-peer-ases

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONFEDERATION-PEER-ASES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/confederation-peer-ases/

Retrieve operation of resource: confederation-peer-ases

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

confederation-peer-ases_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "confederation-peer-as": [
    {
      "as-xx": "string",
      "as-yy": "string"
    }
  ]
}

CONFEDERATION-PEER-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/confederation-peer-ases/confederation-peer-as/{as-xx as-yy}/

Update operation of resource: confederation-peer-as

confederation-peer-as_schema

confederation-peer-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-xx as-yy

in path

string

ID of as-xx as-yy

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONFEDERATION-PEER-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/confederation-peer-ases/confederation-peer-as/{as-xx as-yy}/

Create operation of resource: confederation-peer-as

confederation-peer-as_schema

confederation-peer-asbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-xx as-yy

in path

string

ID of as-xx as-yy

Request Content-Types: application/json

Request Example

{
  "as-xx": "string",
  "as-yy": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONFEDERATION-PEER-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/confederation-peer-ases/confederation-peer-as/{as-xx as-yy}/

Delete operation of resource: confederation-peer-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-xx as-yy

in path

string

ID of as-xx as-yy

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONFEDERATION-PEER-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/confederation-peer-ases/confederation-peer-as/{as-xx as-yy}/

Retrieve operation of resource: confederation-peer-as

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

as-xx as-yy

in path

string

ID of as-xx as-yy

200 OK

confederation-peer-as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as-xx": "string",
  "as-yy": "string"
}

ATTRIBUTE-FILTER-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/attribute-filter-groups/

Update operation of resource: attribute-filter-groups

attribute-filter-groups_schema

attribute-filter-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "attribute-filter-group": [
    {
      "enable": [ null ],
      "attribute-filter-group-name": "string",
      "attribute-filters": {
        "attribute-filter": [
          {
            "attribute-start": "string",
            "attribute-end": "string",
            "filter-action": "string"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ATTRIBUTE-FILTER-GROUPS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/attribute-filter-groups/

Create operation of resource: attribute-filter-groups

attribute-filter-groups_schema

attribute-filter-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "attribute-filter-group": [
    {
      "enable": [ null ],
      "attribute-filter-group-name": "string",
      "attribute-filters": {
        "attribute-filter": [
          {
            "attribute-start": "string",
            "attribute-end": "string",
            "filter-action": "string"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ATTRIBUTE-FILTER-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/attribute-filter-groups/

Retrieve operation of resource: attribute-filter-groups

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

attribute-filter-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "attribute-filter-group": [
    {
      "enable": [ null ],
      "attribute-filter-group-name": "string",
      "attribute-filters": {
        "attribute-filter": [
          {
            "attribute-start": "string",
            "attribute-end": "string",
            "filter-action": "string"
          }
        ]
      }
    }
  ]
}

ATTRIBUTE-FILTER-GROUP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/attribute-filter-groups/attribute-filter-group/{attribute-filter-group-name}/

Update operation of resource: attribute-filter-group

attribute-filter-group_schema

attribute-filter-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

attribute-filter-group-name

in path

string

ID of attribute-filter-group-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "attribute-filter-group-name": "string",
  "attribute-filters": {
    "attribute-filter": [
      {
        "attribute-start": "string",
        "attribute-end": "string",
        "filter-action": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ATTRIBUTE-FILTER-GROUP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/attribute-filter-groups/attribute-filter-group/{attribute-filter-group-name}/

Create operation of resource: attribute-filter-group

attribute-filter-group_schema

attribute-filter-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

attribute-filter-group-name

in path

string

ID of attribute-filter-group-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],
  "attribute-filter-group-name": "string",
  "attribute-filters": {
    "attribute-filter": [
      {
        "attribute-start": "string",
        "attribute-end": "string",
        "filter-action": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ATTRIBUTE-FILTER-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/attribute-filter-groups/attribute-filter-group/{attribute-filter-group-name}/

Retrieve operation of resource: attribute-filter-group

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

attribute-filter-group-name

in path

string

ID of attribute-filter-group-name

200 OK

attribute-filter-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],
  "attribute-filter-group-name": "string",
  "attribute-filters": {
    "attribute-filter": [
      {
        "attribute-start": "string",
        "attribute-end": "string",
        "filter-action": "string"
      }
    ]
  }
}

ATTRIBUTE-FILTERS - Update

Update operation of resource: attribute-filters

attribute-filters_schema

attribute-filtersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

attribute-filter-group-name

in path

string

ID of attribute-filter-group-name

Request Content-Types: application/json

Request Example

{
  "attribute-filter": [
    {
      "attribute-start": "string",
      "attribute-end": "string",
      "filter-action": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ATTRIBUTE-FILTERS - Create

Create operation of resource: attribute-filters

attribute-filters_schema

attribute-filtersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

attribute-filter-group-name

in path

string

ID of attribute-filter-group-name

Request Content-Types: application/json

Request Example

{
  "attribute-filter": [
    {
      "attribute-start": "string",
      "attribute-end": "string",
      "filter-action": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ATTRIBUTE-FILTERS - Retrieve

Retrieve operation of resource: attribute-filters

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

attribute-filter-group-name

in path

string

ID of attribute-filter-group-name

200 OK

attribute-filters_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "attribute-filter": [
    {
      "attribute-start": "string",
      "attribute-end": "string",
      "filter-action": "string"
    }
  ]
}

ATTRIBUTE-FILTER - Update

Update operation of resource: attribute-filter

attribute-filter_schema

attribute-filterbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

attribute-filter-group-name

in path

string

ID of attribute-filter-group-name

attribute-start attribute-end

in path

string

ID of attribute-start attribute-end

Request Content-Types: application/json

Request Example

{
  "attribute-start": "string",
  "attribute-end": "string",
  "filter-action": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ATTRIBUTE-FILTER - Create

Create operation of resource: attribute-filter

attribute-filter_schema

attribute-filterbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

attribute-filter-group-name

in path

string

ID of attribute-filter-group-name

attribute-start attribute-end

in path

string

ID of attribute-start attribute-end

Request Content-Types: application/json

Request Example

{
  "attribute-start": "string",
  "attribute-end": "string",
  "filter-action": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ATTRIBUTE-FILTER - Retrieve

Retrieve operation of resource: attribute-filter

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

attribute-filter-group-name

in path

string

ID of attribute-filter-group-name

attribute-start attribute-end

in path

string

ID of attribute-start attribute-end

200 OK

attribute-filter_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "attribute-start": "string",
  "attribute-end": "string",
  "filter-action": "string"
}

GLOBAL-GRACEFUL-MAINTENANCE-ACTIVATE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-graceful-maintenance-activate/

Update operation of resource: global-graceful-maintenance-activate

global-graceful-maintenance-activate_schema

global-graceful-maintenance-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "retain-routes": "boolean",
  "all-neighbors": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-GRACEFUL-MAINTENANCE-ACTIVATE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-graceful-maintenance-activate/

Create operation of resource: global-graceful-maintenance-activate

global-graceful-maintenance-activate_schema

global-graceful-maintenance-activatebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "retain-routes": "boolean",
  "all-neighbors": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-GRACEFUL-MAINTENANCE-ACTIVATE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-graceful-maintenance-activate/

Delete operation of resource: global-graceful-maintenance-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-GRACEFUL-MAINTENANCE-ACTIVATE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-graceful-maintenance-activate/

Retrieve operation of resource: global-graceful-maintenance-activate

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

global-graceful-maintenance-activate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "retain-routes": "boolean",
  "all-neighbors": "boolean"
}

GLOBAL-AFS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/

Update operation of resource: global-afs

global-afs_schema

global-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "global-af": [
    {
      "isis-routes": {
        "isis-route": [
          {
            "default-metric": "string",
            "route-policy-name": "string",
            "redist-type": "string",
            "instance-name": "string"
          }
        ]
      },
      "global-table-mcast": [ null ],
      "update-limit-sub-group-ebgp": "integer",
      "domain-distinguisher": {
        "as": "string",
        "router-id": "string"
      },
      "segmented-mcast": [ null ],
      "inter-as-install": [ null ],
      "rpki-origin-as-validation-disable": [ null ],
      "disable-client-to-client-rr": [ null ],
      "disable-cluster-client-to-client-rrs": {
        "disable-cluster-client-to-client-rr": [
          {
            "ipv4-address": [
              {
                "cluster-id-address": "string"
              }
            ],
            "cluster-type": "string",
            "number": [
              {
                "cluster-id-number": "integer"
              }
            ]
          }
        ]
      },
      "label-delay": {
        "seconds": "integer",
        "milliseconds": "integer"
      },
      "rnh-install-format": "string",
      "implicit-import": [ null ],
      "label-security-rpf": [ null ],
      "use-igpsr-label": [ null ],
      "wait-rib-install": [ null ],
      "ibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "next-hop-non-critical-trigger-delay": "integer",
      "label-retain": "integer",
      "import-delay": {
        "seconds": "integer",
        "milliseconds": "integer"
      },
      "retain-rt": {
        "all": "boolean",
        "route-policy-name": "string"
      },
      "source-route-target-policy": "string",
      "rpki-bestpath-use-origin-as-validity": [ null ],
      "prefix-sid-map": [ null ],
      "scan-time": "integer",
      "vrf-all": {
        "rnh-install-format": "string",
        "enable": [ null ],
        "srv6-label-allocation-mode": "string",
        "table-policy": "string",
        "source-rt-import-policy": [ null ],
        "label-mode": {
          "route-policy-name": "string",
          "label-allocation-mode": "string"
        }
      },
      "update-limit-sub-group-ibgp": "integer",
      "update-limit-address-family": "integer",
      "eibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "rpki-bestpath-origin-as-allow-invalid": [ null ],
      "next-hop-route-policy": "string",
      "disable-default-martian-check": [ null ],
      "af-name": "string",
      "next-hop-critical-trigger-delay": "integer",
      "ebgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "rpki-origin-as-validity-signal-ibgp": [ null ],
      "subscriber-routes": {
        "default-metric": "string",
        "route-policy-name": "string",
        "not-used": "integer"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-AFS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/

Create operation of resource: global-afs

global-afs_schema

global-afsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "global-af": [
    {
      "isis-routes": {
        "isis-route": [
          {
            "default-metric": "string",
            "route-policy-name": "string",
            "redist-type": "string",
            "instance-name": "string"
          }
        ]
      },
      "global-table-mcast": [ null ],
      "update-limit-sub-group-ebgp": "integer",
      "domain-distinguisher": {
        "as": "string",
        "router-id": "string"
      },
      "segmented-mcast": [ null ],
      "inter-as-install": [ null ],
      "rpki-origin-as-validation-disable": [ null ],
      "disable-client-to-client-rr": [ null ],
      "disable-cluster-client-to-client-rrs": {
        "disable-cluster-client-to-client-rr": [
          {
            "ipv4-address": [
              {
                "cluster-id-address": "string"
              }
            ],
            "cluster-type": "string",
            "number": [
              {
                "cluster-id-number": "integer"
              }
            ]
          }
        ]
      },
      "label-delay": {
        "seconds": "integer",
        "milliseconds": "integer"
      },
      "rnh-install-format": "string",
      "implicit-import": [ null ],
      "label-security-rpf": [ null ],
      "use-igpsr-label": [ null ],
      "wait-rib-install": [ null ],
      "ibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "next-hop-non-critical-trigger-delay": "integer",
      "label-retain": "integer",
      "import-delay": {
        "seconds": "integer",
        "milliseconds": "integer"
      },
      "retain-rt": {
        "all": "boolean",
        "route-policy-name": "string"
      },
      "source-route-target-policy": "string",
      "rpki-bestpath-use-origin-as-validity": [ null ],
      "prefix-sid-map": [ null ],
      "scan-time": "integer",
      "vrf-all": {
        "rnh-install-format": "string",
        "enable": [ null ],
        "srv6-label-allocation-mode": "string",
        "table-policy": "string",
        "source-rt-import-policy": [ null ],
        "label-mode": {
          "route-policy-name": "string",
          "label-allocation-mode": "string"
        }
      },
      "update-limit-sub-group-ibgp": "integer",
      "update-limit-address-family": "integer",
      "eibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "rpki-bestpath-origin-as-allow-invalid": [ null ],
      "next-hop-route-policy": "string",
      "disable-default-martian-check": [ null ],
      "af-name": "string",
      "next-hop-critical-trigger-delay": "integer",
      "ebgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "rpki-origin-as-validity-signal-ibgp": [ null ],
      "subscriber-routes": {
        "default-metric": "string",
        "route-policy-name": "string",
        "not-used": "integer"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-AFS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/

Delete operation of resource: global-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-AFS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/

Retrieve operation of resource: global-afs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

global-afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "global-af": [
    {
      "isis-routes": {
        "isis-route": [
          {
            "default-metric": "string",
            "route-policy-name": "string",
            "redist-type": "string",
            "instance-name": "string"
          }
        ]
      },
      "global-table-mcast": [ null ],
      "update-limit-sub-group-ebgp": "integer",
      "domain-distinguisher": {
        "as": "string",
        "router-id": "string"
      },
      "segmented-mcast": [ null ],
      "inter-as-install": [ null ],
      "rpki-origin-as-validation-disable": [ null ],
      "disable-client-to-client-rr": [ null ],
      "disable-cluster-client-to-client-rrs": {
        "disable-cluster-client-to-client-rr": [
          {
            "ipv4-address": [
              {
                "cluster-id-address": "string"
              }
            ],
            "cluster-type": "string",
            "number": [
              {
                "cluster-id-number": "integer"
              }
            ]
          }
        ]
      },
      "label-delay": {
        "seconds": "integer",
        "milliseconds": "integer"
      },
      "rnh-install-format": "string",
      "implicit-import": [ null ],
      "label-security-rpf": [ null ],
      "use-igpsr-label": [ null ],
      "wait-rib-install": [ null ],
      "ibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "next-hop-non-critical-trigger-delay": "integer",
      "label-retain": "integer",
      "import-delay": {
        "seconds": "integer",
        "milliseconds": "integer"
      },
      "retain-rt": {
        "all": "boolean",
        "route-policy-name": "string"
      },
      "source-route-target-policy": "string",
      "rpki-bestpath-use-origin-as-validity": [ null ],
      "prefix-sid-map": [ null ],
      "scan-time": "integer",
      "vrf-all": {
        "rnh-install-format": "string",
        "enable": [ null ],
        "srv6-label-allocation-mode": "string",
        "table-policy": "string",
        "source-rt-import-policy": [ null ],
        "label-mode": {
          "route-policy-name": "string",
          "label-allocation-mode": "string"
        }
      },
      "update-limit-sub-group-ibgp": "integer",
      "update-limit-address-family": "integer",
      "eibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "rpki-bestpath-origin-as-allow-invalid": [ null ],
      "next-hop-route-policy": "string",
      "disable-default-martian-check": [ null ],
      "af-name": "string",
      "next-hop-critical-trigger-delay": "integer",
      "ebgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "rpki-origin-as-validity-signal-ibgp": [ null ],
      "subscriber-routes": {
        "default-metric": "string",
        "route-policy-name": "string",
        "not-used": "integer"
      }
    }
  ]
}

GLOBAL-AF - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/

Update operation of resource: global-af

global-af_schema

global-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "isis-routes": {
    "isis-route": [
      {
        "default-metric": "string",
        "route-policy-name": "string",
        "redist-type": "string",
        "instance-name": "string"
      }
    ]
  },
  "global-table-mcast": [ null ],
  "update-limit-sub-group-ebgp": "integer",
  "domain-distinguisher": {
    "as": "string",
    "router-id": "string"
  },
  "segmented-mcast": [ null ],
  "inter-as-install": [ null ],
  "rpki-origin-as-validation-disable": [ null ],
  "disable-client-to-client-rr": [ null ],
  "disable-cluster-client-to-client-rrs": {
    "disable-cluster-client-to-client-rr": [
      {
        "ipv4-address": [
          {
            "cluster-id-address": "string"
          }
        ],
        "cluster-type": "string",
        "number": [
          {
            "cluster-id-number": "integer"
          }
        ]
      }
    ]
  },
  "label-delay": {
    "seconds": "integer",
    "milliseconds": "integer"
  },
  "rnh-install-format": "string",
  "implicit-import": [ null ],
  "label-security-rpf": [ null ],
  "use-igpsr-label": [ null ],
  "wait-rib-install": [ null ],
  "ibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "next-hop-non-critical-trigger-delay": "integer",
  "label-retain": "integer",
  "import-delay": {
    "seconds": "integer",
    "milliseconds": "integer"
  },
  "retain-rt": {
    "all": "boolean",
    "route-policy-name": "string"
  },
  "source-route-target-policy": "string",
  "rpki-bestpath-use-origin-as-validity": [ null ],
  "prefix-sid-map": [ null ],
  "scan-time": "integer",
  "vrf-all": {
    "rnh-install-format": "string",
    "enable": [ null ],
    "srv6-label-allocation-mode": "string",
    "table-policy": "string",
    "source-rt-import-policy": [ null ],
    "label-mode": {
      "route-policy-name": "string",
      "label-allocation-mode": "string"
    }
  },
  "update-limit-sub-group-ibgp": "integer",
  "update-limit-address-family": "integer",
  "eibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "rpki-bestpath-origin-as-allow-invalid": [ null ],
  "next-hop-route-policy": "string",
  "disable-default-martian-check": [ null ],
  "af-name": "string",
  "next-hop-critical-trigger-delay": "integer",
  "ebgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "rpki-origin-as-validity-signal-ibgp": [ null ],
  "subscriber-routes": {
    "default-metric": "string",
    "route-policy-name": "string",
    "not-used": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-AF - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/

Create operation of resource: global-af

global-af_schema

global-afbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "isis-routes": {
    "isis-route": [
      {
        "default-metric": "string",
        "route-policy-name": "string",
        "redist-type": "string",
        "instance-name": "string"
      }
    ]
  },
  "global-table-mcast": [ null ],
  "update-limit-sub-group-ebgp": "integer",
  "domain-distinguisher": {
    "as": "string",
    "router-id": "string"
  },
  "segmented-mcast": [ null ],
  "inter-as-install": [ null ],
  "rpki-origin-as-validation-disable": [ null ],
  "disable-client-to-client-rr": [ null ],
  "disable-cluster-client-to-client-rrs": {
    "disable-cluster-client-to-client-rr": [
      {
        "ipv4-address": [
          {
            "cluster-id-address": "string"
          }
        ],
        "cluster-type": "string",
        "number": [
          {
            "cluster-id-number": "integer"
          }
        ]
      }
    ]
  },
  "label-delay": {
    "seconds": "integer",
    "milliseconds": "integer"
  },
  "rnh-install-format": "string",
  "implicit-import": [ null ],
  "label-security-rpf": [ null ],
  "use-igpsr-label": [ null ],
  "wait-rib-install": [ null ],
  "ibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "next-hop-non-critical-trigger-delay": "integer",
  "label-retain": "integer",
  "import-delay": {
    "seconds": "integer",
    "milliseconds": "integer"
  },
  "retain-rt": {
    "all": "boolean",
    "route-policy-name": "string"
  },
  "source-route-target-policy": "string",
  "rpki-bestpath-use-origin-as-validity": [ null ],
  "prefix-sid-map": [ null ],
  "scan-time": "integer",
  "vrf-all": {
    "rnh-install-format": "string",
    "enable": [ null ],
    "srv6-label-allocation-mode": "string",
    "table-policy": "string",
    "source-rt-import-policy": [ null ],
    "label-mode": {
      "route-policy-name": "string",
      "label-allocation-mode": "string"
    }
  },
  "update-limit-sub-group-ibgp": "integer",
  "update-limit-address-family": "integer",
  "eibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "rpki-bestpath-origin-as-allow-invalid": [ null ],
  "next-hop-route-policy": "string",
  "disable-default-martian-check": [ null ],
  "af-name": "string",
  "next-hop-critical-trigger-delay": "integer",
  "ebgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "rpki-origin-as-validity-signal-ibgp": [ null ],
  "subscriber-routes": {
    "default-metric": "string",
    "route-policy-name": "string",
    "not-used": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-AF - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/

Delete operation of resource: global-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-AF - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/

Retrieve operation of resource: global-af

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

global-af_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "isis-routes": {
    "isis-route": [
      {
        "default-metric": "string",
        "route-policy-name": "string",
        "redist-type": "string",
        "instance-name": "string"
      }
    ]
  },
  "global-table-mcast": [ null ],
  "update-limit-sub-group-ebgp": "integer",
  "domain-distinguisher": {
    "as": "string",
    "router-id": "string"
  },
  "segmented-mcast": [ null ],
  "inter-as-install": [ null ],
  "rpki-origin-as-validation-disable": [ null ],
  "disable-client-to-client-rr": [ null ],
  "disable-cluster-client-to-client-rrs": {
    "disable-cluster-client-to-client-rr": [
      {
        "ipv4-address": [
          {
            "cluster-id-address": "string"
          }
        ],
        "cluster-type": "string",
        "number": [
          {
            "cluster-id-number": "integer"
          }
        ]
      }
    ]
  },
  "label-delay": {
    "seconds": "integer",
    "milliseconds": "integer"
  },
  "rnh-install-format": "string",
  "implicit-import": [ null ],
  "label-security-rpf": [ null ],
  "use-igpsr-label": [ null ],
  "wait-rib-install": [ null ],
  "ibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "next-hop-non-critical-trigger-delay": "integer",
  "label-retain": "integer",
  "import-delay": {
    "seconds": "integer",
    "milliseconds": "integer"
  },
  "retain-rt": {
    "all": "boolean",
    "route-policy-name": "string"
  },
  "source-route-target-policy": "string",
  "rpki-bestpath-use-origin-as-validity": [ null ],
  "prefix-sid-map": [ null ],
  "scan-time": "integer",
  "vrf-all": {
    "rnh-install-format": "string",
    "enable": [ null ],
    "srv6-label-allocation-mode": "string",
    "table-policy": "string",
    "source-rt-import-policy": [ null ],
    "label-mode": {
      "route-policy-name": "string",
      "label-allocation-mode": "string"
    }
  },
  "update-limit-sub-group-ibgp": "integer",
  "update-limit-address-family": "integer",
  "eibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "rpki-bestpath-origin-as-allow-invalid": [ null ],
  "next-hop-route-policy": "string",
  "disable-default-martian-check": [ null ],
  "af-name": "string",
  "next-hop-critical-trigger-delay": "integer",
  "ebgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "rpki-origin-as-validity-signal-ibgp": [ null ],
  "subscriber-routes": {
    "default-metric": "string",
    "route-policy-name": "string",
    "not-used": "integer"
  }
}

ISIS-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/isis-routes/

Update operation of resource: isis-routes

isis-routes_schema

isis-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "isis-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ISIS-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/isis-routes/

Create operation of resource: isis-routes

isis-routes_schema

isis-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "isis-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ISIS-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/isis-routes/

Delete operation of resource: isis-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ISIS-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/isis-routes/

Retrieve operation of resource: isis-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

isis-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "isis-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

ISIS-ROUTE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/isis-routes/isis-route/{instance-name}/

Update operation of resource: isis-route

isis-route_schema

isis-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ISIS-ROUTE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/isis-routes/isis-route/{instance-name}/

Create operation of resource: isis-route

isis-route_schema

isis-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ISIS-ROUTE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/isis-routes/isis-route/{instance-name}/

Delete operation of resource: isis-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ISIS-ROUTE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/isis-routes/isis-route/{instance-name}/

Retrieve operation of resource: isis-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

isis-route_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

DOMAIN-DISTINGUISHER - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/domain-distinguisher/

Update operation of resource: domain-distinguisher

domain-distinguisher_schema

domain-distinguisherbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "as": "string",
  "router-id": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAIN-DISTINGUISHER - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/domain-distinguisher/

Create operation of resource: domain-distinguisher

domain-distinguisher_schema

domain-distinguisherbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "as": "string",
  "router-id": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAIN-DISTINGUISHER - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/domain-distinguisher/

Delete operation of resource: domain-distinguisher

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOMAIN-DISTINGUISHER - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/domain-distinguisher/

Retrieve operation of resource: domain-distinguisher

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

domain-distinguisher_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "as": "string",
  "router-id": "string"
}

VRF-ALL - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/vrf-all/

Update operation of resource: vrf-all

vrf-all_schema

vrf-allbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "rnh-install-format": "string",
  "enable": [ null ],
  "srv6-label-allocation-mode": "string",
  "table-policy": "string",
  "source-rt-import-policy": [ null ],
  "label-mode": {
    "route-policy-name": "string",
    "label-allocation-mode": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-ALL - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/vrf-all/

Create operation of resource: vrf-all

vrf-all_schema

vrf-allbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "rnh-install-format": "string",
  "enable": [ null ],
  "srv6-label-allocation-mode": "string",
  "table-policy": "string",
  "source-rt-import-policy": [ null ],
  "label-mode": {
    "route-policy-name": "string",
    "label-allocation-mode": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-ALL - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/vrf-all/

Delete operation of resource: vrf-all

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-ALL - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/vrf-all/

Retrieve operation of resource: vrf-all

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

vrf-all_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "rnh-install-format": "string",
  "enable": [ null ],
  "srv6-label-allocation-mode": "string",
  "table-policy": "string",
  "source-rt-import-policy": [ null ],
  "label-mode": {
    "route-policy-name": "string",
    "label-allocation-mode": "string"
  }
}

LABEL-MODE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/vrf-all/label-mode/

Update operation of resource: label-mode

label-mode_schema

label-modebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "route-policy-name": "string",
  "label-allocation-mode": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-MODE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/vrf-all/label-mode/

Create operation of resource: label-mode

label-mode_schema

label-modebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "route-policy-name": "string",
  "label-allocation-mode": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-MODE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/vrf-all/label-mode/

Delete operation of resource: label-mode

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-MODE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/vrf-all/label-mode/

Retrieve operation of resource: label-mode

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

label-mode_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "route-policy-name": "string",
  "label-allocation-mode": "string"
}

DISABLE-CLUSTER-CLIENT-TO-CLIENT-RRS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/disable-cluster-client-to-client-rrs/

Update operation of resource: disable-cluster-client-to-client-rrs

disable-cluster-client-to-client-rrs_schema

disable-cluster-client-to-client-rrsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "disable-cluster-client-to-client-rr": [
    {
      "ipv4-address": [
        {
          "cluster-id-address": "string"
        }
      ],
      "cluster-type": "string",
      "number": [
        {
          "cluster-id-number": "integer"
        }
      ]
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISABLE-CLUSTER-CLIENT-TO-CLIENT-RRS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/disable-cluster-client-to-client-rrs/

Create operation of resource: disable-cluster-client-to-client-rrs

disable-cluster-client-to-client-rrs_schema

disable-cluster-client-to-client-rrsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "disable-cluster-client-to-client-rr": [
    {
      "ipv4-address": [
        {
          "cluster-id-address": "string"
        }
      ],
      "cluster-type": "string",
      "number": [
        {
          "cluster-id-number": "integer"
        }
      ]
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISABLE-CLUSTER-CLIENT-TO-CLIENT-RRS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/disable-cluster-client-to-client-rrs/

Delete operation of resource: disable-cluster-client-to-client-rrs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISABLE-CLUSTER-CLIENT-TO-CLIENT-RRS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/disable-cluster-client-to-client-rrs/

Retrieve operation of resource: disable-cluster-client-to-client-rrs

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

disable-cluster-client-to-client-rrs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "disable-cluster-client-to-client-rr": [
    {
      "ipv4-address": [
        {
          "cluster-id-address": "string"
        }
      ],
      "cluster-type": "string",
      "number": [
        {
          "cluster-id-number": "integer"
        }
      ]
    }
  ]
}

DISABLE-CLUSTER-CLIENT-TO-CLIENT-RR - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/disable-cluster-client-to-client-rrs/disable-cluster-client-to-client-rr/{cluster-type}/

Update operation of resource: disable-cluster-client-to-client-rr

disable-cluster-client-to-client-rr_schema

disable-cluster-client-to-client-rrbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

cluster-type

in path

string

ID of cluster-type

Request Content-Types: application/json

Request Example

{
  "ipv4-address": [
    {
      "cluster-id-address": "string"
    }
  ],
  "cluster-type": "string",
  "number": [
    {
      "cluster-id-number": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISABLE-CLUSTER-CLIENT-TO-CLIENT-RR - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/disable-cluster-client-to-client-rrs/disable-cluster-client-to-client-rr/{cluster-type}/

Create operation of resource: disable-cluster-client-to-client-rr

disable-cluster-client-to-client-rr_schema

disable-cluster-client-to-client-rrbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

cluster-type

in path

string

ID of cluster-type

Request Content-Types: application/json

Request Example

{
  "ipv4-address": [
    {
      "cluster-id-address": "string"
    }
  ],
  "cluster-type": "string",
  "number": [
    {
      "cluster-id-number": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISABLE-CLUSTER-CLIENT-TO-CLIENT-RR - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/disable-cluster-client-to-client-rrs/disable-cluster-client-to-client-rr/{cluster-type}/

Delete operation of resource: disable-cluster-client-to-client-rr

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

cluster-type

in path

string

ID of cluster-type

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISABLE-CLUSTER-CLIENT-TO-CLIENT-RR - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/disable-cluster-client-to-client-rrs/disable-cluster-client-to-client-rr/{cluster-type}/

Retrieve operation of resource: disable-cluster-client-to-client-rr

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

cluster-type

in path

string

ID of cluster-type

200 OK

disable-cluster-client-to-client-rr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "ipv4-address": [
    {
      "cluster-id-address": "string"
    }
  ],
  "cluster-type": "string",
  "number": [
    {
      "cluster-id-number": "integer"
    }
  ]
}

NUMBER - Update

Update operation of resource: number

number_schema

numberbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

cluster-type

in path

string

ID of cluster-type

cluster-id-number

in path

string

ID of cluster-id-number

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NUMBER - Create

Create operation of resource: number

number_schema

numberbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

cluster-type

in path

string

ID of cluster-type

cluster-id-number

in path

string

ID of cluster-id-number

Request Content-Types: application/json

Request Example

{
  "cluster-id-number": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NUMBER - Delete

Delete operation of resource: number

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

cluster-type

in path

string

ID of cluster-type

cluster-id-number

in path

string

ID of cluster-id-number

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NUMBER - Retrieve

Retrieve operation of resource: number

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

cluster-type

in path

string

ID of cluster-type

cluster-id-number

in path

string

ID of cluster-id-number

200 OK

number_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "cluster-id-number": "integer"
}

IPV4-ADDRESS - Update

Update operation of resource: ipv4-address

ipv4-address_schema

ipv4-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

cluster-type

in path

string

ID of cluster-type

cluster-id-address

in path

string

ID of cluster-id-address

Request Content-Types: application/json

Request Example

{
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4-ADDRESS - Create

Create operation of resource: ipv4-address

ipv4-address_schema

ipv4-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

cluster-type

in path

string

ID of cluster-type

cluster-id-address

in path

string

ID of cluster-id-address

Request Content-Types: application/json

Request Example

{
  "cluster-id-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4-ADDRESS - Delete

Delete operation of resource: ipv4-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

cluster-type

in path

string

ID of cluster-type

cluster-id-address

in path

string

ID of cluster-id-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4-ADDRESS - Retrieve

Retrieve operation of resource: ipv4-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

cluster-type

in path

string

ID of cluster-type

cluster-id-address

in path

string

ID of cluster-id-address

200 OK

ipv4-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "cluster-id-address": "string"
}

LABEL-DELAY - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/label-delay/

Update operation of resource: label-delay

label-delay_schema

label-delaybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "seconds": "integer",
  "milliseconds": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-DELAY - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/label-delay/

Create operation of resource: label-delay

label-delay_schema

label-delaybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "seconds": "integer",
  "milliseconds": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-DELAY - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/label-delay/

Delete operation of resource: label-delay

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-DELAY - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/label-delay/

Retrieve operation of resource: label-delay

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

label-delay_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "seconds": "integer",
  "milliseconds": "integer"
}

EBGP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ebgp/

Update operation of resource: ebgp

ebgp_schema

ebgpbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ebgp/

Create operation of resource: ebgp

ebgp_schema

ebgpbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ebgp/

Delete operation of resource: ebgp

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ebgp/

Retrieve operation of resource: ebgp

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

ebgp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

EIBGP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/eibgp/

Update operation of resource: eibgp

eibgp_schema

eibgpbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIBGP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/eibgp/

Create operation of resource: eibgp

eibgp_schema

eibgpbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIBGP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/eibgp/

Delete operation of resource: eibgp

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIBGP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/eibgp/

Retrieve operation of resource: eibgp

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

eibgp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

RETAIN-RT - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/retain-rt/

Update operation of resource: retain-rt

retain-rt_schema

retain-rtbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "all": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RETAIN-RT - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/retain-rt/

Create operation of resource: retain-rt

retain-rt_schema

retain-rtbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "all": "boolean",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RETAIN-RT - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/retain-rt/

Delete operation of resource: retain-rt

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RETAIN-RT - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/retain-rt/

Retrieve operation of resource: retain-rt

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

retain-rt_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "all": "boolean",
  "route-policy-name": "string"
}

IBGP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ibgp/

Update operation of resource: ibgp

ibgp_schema

ibgpbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IBGP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ibgp/

Create operation of resource: ibgp

ibgp_schema

ibgpbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IBGP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ibgp/

Delete operation of resource: ibgp

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IBGP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ibgp/

Retrieve operation of resource: ibgp

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

ibgp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

IMPORT-DELAY - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/import-delay/

Update operation of resource: import-delay

import-delay_schema

import-delaybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "seconds": "integer",
  "milliseconds": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT-DELAY - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/import-delay/

Create operation of resource: import-delay

import-delay_schema

import-delaybody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "seconds": "integer",
  "milliseconds": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT-DELAY - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/import-delay/

Delete operation of resource: import-delay

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IMPORT-DELAY - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/import-delay/

Retrieve operation of resource: import-delay

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

import-delay_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "seconds": "integer",
  "milliseconds": "integer"
}

AGGREGATE-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/aggregate-addresses/

Update operation of resource: aggregate-addresses

aggregate-addresses_schema

aggregate-addressesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "aggregate-address": [
    {
      "route-policy-name": "string",
      "aggregate-prefix": "integer",
      "summary-only": "boolean",
      "generate-set-info": "boolean",
      "generate-confederation-set-info": "boolean",
      "aggregate-addr": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/aggregate-addresses/

Create operation of resource: aggregate-addresses

aggregate-addresses_schema

aggregate-addressesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "aggregate-address": [
    {
      "route-policy-name": "string",
      "aggregate-prefix": "integer",
      "summary-only": "boolean",
      "generate-set-info": "boolean",
      "generate-confederation-set-info": "boolean",
      "aggregate-addr": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/aggregate-addresses/

Delete operation of resource: aggregate-addresses

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/aggregate-addresses/

Retrieve operation of resource: aggregate-addresses

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

aggregate-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "aggregate-address": [
    {
      "route-policy-name": "string",
      "aggregate-prefix": "integer",
      "summary-only": "boolean",
      "generate-set-info": "boolean",
      "generate-confederation-set-info": "boolean",
      "aggregate-addr": "string"
    }
  ]
}

AGGREGATE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/aggregate-addresses/aggregate-address/{aggregate-addr aggregate-prefix}/

Update operation of resource: aggregate-address

aggregate-address_schema

aggregate-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

aggregate-addr aggregate-prefix

in path

string

ID of aggregate-addr aggregate-prefix

Request Content-Types: application/json

Request Example

{
  "route-policy-name": "string",
  "aggregate-prefix": "integer",
  "summary-only": "boolean",
  "generate-set-info": "boolean",
  "generate-confederation-set-info": "boolean",
  "aggregate-addr": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/aggregate-addresses/aggregate-address/{aggregate-addr aggregate-prefix}/

Create operation of resource: aggregate-address

aggregate-address_schema

aggregate-addressbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

aggregate-addr aggregate-prefix

in path

string

ID of aggregate-addr aggregate-prefix

Request Content-Types: application/json

Request Example

{
  "route-policy-name": "string",
  "aggregate-prefix": "integer",
  "summary-only": "boolean",
  "generate-set-info": "boolean",
  "generate-confederation-set-info": "boolean",
  "aggregate-addr": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/aggregate-addresses/aggregate-address/{aggregate-addr aggregate-prefix}/

Delete operation of resource: aggregate-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

aggregate-addr aggregate-prefix

in path

string

ID of aggregate-addr aggregate-prefix

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/aggregate-addresses/aggregate-address/{aggregate-addr aggregate-prefix}/

Retrieve operation of resource: aggregate-address

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

aggregate-addr aggregate-prefix

in path

string

ID of aggregate-addr aggregate-prefix

200 OK

aggregate-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "route-policy-name": "string",
  "aggregate-prefix": "integer",
  "summary-only": "boolean",
  "generate-set-info": "boolean",
  "generate-confederation-set-info": "boolean",
  "aggregate-addr": "string"
}

OPTIMAL-ROUTE-REFLECTOR-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/optimal-route-reflector-groups/

Update operation of resource: optimal-route-reflector-groups

optimal-route-reflector-groups_schema

optimal-route-reflector-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "optimal-route-reflector-group": [
    {
      "primary-root-address": "string",
      "group-name": "string",
      "tertiary-root-address": "string",
      "secondary-root-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUPS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/optimal-route-reflector-groups/

Create operation of resource: optimal-route-reflector-groups

optimal-route-reflector-groups_schema

optimal-route-reflector-groupsbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "optimal-route-reflector-group": [
    {
      "primary-root-address": "string",
      "group-name": "string",
      "tertiary-root-address": "string",
      "secondary-root-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/optimal-route-reflector-groups/

Delete operation of resource: optimal-route-reflector-groups

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/optimal-route-reflector-groups/

Retrieve operation of resource: optimal-route-reflector-groups

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

optimal-route-reflector-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "optimal-route-reflector-group": [
    {
      "primary-root-address": "string",
      "group-name": "string",
      "tertiary-root-address": "string",
      "secondary-root-address": "string"
    }
  ]
}

OPTIMAL-ROUTE-REFLECTOR-GROUP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/optimal-route-reflector-groups/optimal-route-reflector-group/{group-name}/

Update operation of resource: optimal-route-reflector-group

optimal-route-reflector-group_schema

optimal-route-reflector-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

group-name

in path

string

ID of group-name

Request Content-Types: application/json

Request Example

{
  "primary-root-address": "string",
  "group-name": "string",
  "tertiary-root-address": "string",
  "secondary-root-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/optimal-route-reflector-groups/optimal-route-reflector-group/{group-name}/

Create operation of resource: optimal-route-reflector-group

optimal-route-reflector-group_schema

optimal-route-reflector-groupbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

group-name

in path

string

ID of group-name

Request Content-Types: application/json

Request Example

{
  "primary-root-address": "string",
  "group-name": "string",
  "tertiary-root-address": "string",
  "secondary-root-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/optimal-route-reflector-groups/optimal-route-reflector-group/{group-name}/

Delete operation of resource: optimal-route-reflector-group

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

group-name

in path

string

ID of group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/optimal-route-reflector-groups/optimal-route-reflector-group/{group-name}/

Retrieve operation of resource: optimal-route-reflector-group

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

group-name

in path

string

ID of group-name

200 OK

optimal-route-reflector-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "primary-root-address": "string",
  "group-name": "string",
  "tertiary-root-address": "string",
  "secondary-root-address": "string"
}

DAMPENING - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/dampening/

Update operation of resource: dampening

dampening_schema

dampeningbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "reuse-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "suppress-threshold": "integer",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/dampening/

Create operation of resource: dampening

dampening_schema

dampeningbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "reuse-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "suppress-threshold": "integer",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/dampening/

Delete operation of resource: dampening

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/dampening/

Retrieve operation of resource: dampening

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

dampening_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "reuse-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "suppress-threshold": "integer",
  "route-policy-name": "string"
}

RIP-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/rip-routes/

Update operation of resource: rip-routes

rip-routes_schema

rip-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RIP-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/rip-routes/

Create operation of resource: rip-routes

rip-routes_schema

rip-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RIP-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/rip-routes/

Delete operation of resource: rip-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RIP-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/rip-routes/

Retrieve operation of resource: rip-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

rip-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

LISP-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/lisp-routes/

Update operation of resource: lisp-routes

lisp-routes_schema

lisp-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LISP-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/lisp-routes/

Create operation of resource: lisp-routes

lisp-routes_schema

lisp-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LISP-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/lisp-routes/

Delete operation of resource: lisp-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LISP-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/lisp-routes/

Retrieve operation of resource: lisp-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

lisp-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string"
}

STATIC-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/static-routes/

Update operation of resource: static-routes

static-routes_schema

static-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/static-routes/

Create operation of resource: static-routes

static-routes_schema

static-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/static-routes/

Delete operation of resource: static-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/static-routes/

Retrieve operation of resource: static-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

static-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

DISTANCE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/distance/

Update operation of resource: distance

distance_schema

distancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "external-routes": "integer",
  "local-routes": "integer",
  "internal-routes": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISTANCE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/distance/

Create operation of resource: distance

distance_schema

distancebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "external-routes": "integer",
  "local-routes": "integer",
  "internal-routes": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISTANCE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/distance/

Delete operation of resource: distance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISTANCE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/distance/

Retrieve operation of resource: distance

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

distance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "external-routes": "integer",
  "local-routes": "integer",
  "internal-routes": "integer"
}

APPLICATION-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/application-routes/

Update operation of resource: application-routes

application-routes_schema

application-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "application-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "instance-name": "string",
      "not-used": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/application-routes/

Create operation of resource: application-routes

application-routes_schema

application-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "application-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "instance-name": "string",
      "not-used": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/application-routes/

Delete operation of resource: application-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/application-routes/

Retrieve operation of resource: application-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

application-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "application-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "instance-name": "string",
      "not-used": "integer"
    }
  ]
}

APPLICATION-ROUTE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/application-routes/application-route/{instance-name}/

Update operation of resource: application-route

application-route_schema

application-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "instance-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/application-routes/application-route/{instance-name}/

Create operation of resource: application-route

application-route_schema

application-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "instance-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/application-routes/application-route/{instance-name}/

Delete operation of resource: application-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/application-routes/application-route/{instance-name}/

Retrieve operation of resource: application-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

application-route_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "instance-name": "string",
  "not-used": "integer"
}

LABEL-MODE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/label-mode/

Update operation of resource: label-mode

label-mode_schema

label-modebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "route-policy-name": "string",
  "label-allocation-mode": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-MODE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/label-mode/

Create operation of resource: label-mode

label-mode_schema

label-modebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "route-policy-name": "string",
  "label-allocation-mode": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-MODE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/label-mode/

Delete operation of resource: label-mode

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-MODE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/label-mode/

Retrieve operation of resource: label-mode

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

label-mode_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "route-policy-name": "string",
  "label-allocation-mode": "string"
}

EIGRP-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/eigrp-routes/

Update operation of resource: eigrp-routes

eigrp-routes_schema

eigrp-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "eigrp-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/eigrp-routes/

Create operation of resource: eigrp-routes

eigrp-routes_schema

eigrp-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "eigrp-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/eigrp-routes/

Delete operation of resource: eigrp-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/eigrp-routes/

Retrieve operation of resource: eigrp-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

eigrp-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "eigrp-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

EIGRP-ROUTE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/eigrp-routes/eigrp-route/{instance-name}/

Update operation of resource: eigrp-route

eigrp-route_schema

eigrp-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/eigrp-routes/eigrp-route/{instance-name}/

Create operation of resource: eigrp-route

eigrp-route_schema

eigrp-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTE - Delete

Delete operation of resource: eigrp-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/eigrp-routes/eigrp-route/{instance-name}/

Retrieve operation of resource: eigrp-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

eigrp-route_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

SOURCED-NETWORKS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/sourced-networks/

Update operation of resource: sourced-networks

sourced-networks_schema

sourced-networksbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "sourced-network": [
    {
      "network-prefix": "integer",
      "route-policy-name": "string",
      "network-addr": "string",
      "backdoor": "boolean"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORKS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/sourced-networks/

Create operation of resource: sourced-networks

sourced-networks_schema

sourced-networksbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "sourced-network": [
    {
      "network-prefix": "integer",
      "route-policy-name": "string",
      "network-addr": "string",
      "backdoor": "boolean"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORKS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/sourced-networks/

Delete operation of resource: sourced-networks

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORKS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/sourced-networks/

Retrieve operation of resource: sourced-networks

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

sourced-networks_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "sourced-network": [
    {
      "network-prefix": "integer",
      "route-policy-name": "string",
      "network-addr": "string",
      "backdoor": "boolean"
    }
  ]
}

SOURCED-NETWORK - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/sourced-networks/sourced-network/{network-addr network-prefix}/

Update operation of resource: sourced-network

sourced-network_schema

sourced-networkbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

network-addr network-prefix

in path

string

ID of network-addr network-prefix

Request Content-Types: application/json

Request Example

{
  "network-prefix": "integer",
  "route-policy-name": "string",
  "network-addr": "string",
  "backdoor": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORK - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/sourced-networks/sourced-network/{network-addr network-prefix}/

Create operation of resource: sourced-network

sourced-network_schema

sourced-networkbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

network-addr network-prefix

in path

string

ID of network-addr network-prefix

Request Content-Types: application/json

Request Example

{
  "network-prefix": "integer",
  "route-policy-name": "string",
  "network-addr": "string",
  "backdoor": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORK - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/sourced-networks/sourced-network/{network-addr network-prefix}/

Delete operation of resource: sourced-network

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

network-addr network-prefix

in path

string

ID of network-addr network-prefix

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORK - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/sourced-networks/sourced-network/{network-addr network-prefix}/

Retrieve operation of resource: sourced-network

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

network-addr network-prefix

in path

string

ID of network-addr network-prefix

200 OK

sourced-network_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "network-prefix": "integer",
  "route-policy-name": "string",
  "network-addr": "string",
  "backdoor": "boolean"
}

CONNECTED-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/connected-routes/

Update operation of resource: connected-routes

connected-routes_schema

connected-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONNECTED-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/connected-routes/

Create operation of resource: connected-routes

connected-routes_schema

connected-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONNECTED-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/connected-routes/

Delete operation of resource: connected-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONNECTED-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/connected-routes/

Retrieve operation of resource: connected-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

connected-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

ALLOCATE-LABEL - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/allocate-label/

Update operation of resource: allocate-label

allocate-label_schema

allocate-labelbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "all": "boolean",
  "route-policy-name": "string",
  "un-labeled-path": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOCATE-LABEL - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/allocate-label/

Create operation of resource: allocate-label

allocate-label_schema

allocate-labelbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "all": "boolean",
  "route-policy-name": "string",
  "un-labeled-path": "boolean"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOCATE-LABEL - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/allocate-label/

Delete operation of resource: allocate-label

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOCATE-LABEL - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/allocate-label/

Retrieve operation of resource: allocate-label

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

allocate-label_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "all": "boolean",
  "route-policy-name": "string",
  "un-labeled-path": "boolean"
}

ADDITIONAL-PATHS-SELECTION - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/additional-paths-selection/

Update operation of resource: additional-paths-selection

additional-paths-selection_schema

additional-paths-selectionbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "selection": "string",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDITIONAL-PATHS-SELECTION - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/additional-paths-selection/

Create operation of resource: additional-paths-selection

additional-paths-selection_schema

additional-paths-selectionbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "selection": "string",
  "route-policy-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDITIONAL-PATHS-SELECTION - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/additional-paths-selection/

Delete operation of resource: additional-paths-selection

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDITIONAL-PATHS-SELECTION - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/additional-paths-selection/

Retrieve operation of resource: additional-paths-selection

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

additional-paths-selection_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "selection": "string",
  "route-policy-name": "string"
}

OSPF-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ospf-routes/

Update operation of resource: ospf-routes

ospf-routes_schema

ospf-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "ospf-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OSPF-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ospf-routes/

Create operation of resource: ospf-routes

ospf-routes_schema

ospf-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "ospf-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OSPF-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ospf-routes/

Delete operation of resource: ospf-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OSPF-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ospf-routes/

Retrieve operation of resource: ospf-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

ospf-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "ospf-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

OSPF-ROUTE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ospf-routes/ospf-route/{instance-name}/

Update operation of resource: ospf-route

ospf-route_schema

ospf-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OSPF-ROUTE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ospf-routes/ospf-route/{instance-name}/

Create operation of resource: ospf-route

ospf-route_schema

ospf-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OSPF-ROUTE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ospf-routes/ospf-route/{instance-name}/

Delete operation of resource: ospf-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OSPF-ROUTE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/ospf-routes/ospf-route/{instance-name}/

Retrieve operation of resource: ospf-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

instance-name

in path

string

ID of instance-name

200 OK

ospf-route_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

MOBILE-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/mobile-routes/

Update operation of resource: mobile-routes

mobile-routes_schema

mobile-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MOBILE-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/mobile-routes/

Create operation of resource: mobile-routes

mobile-routes_schema

mobile-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MOBILE-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/mobile-routes/

Delete operation of resource: mobile-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MOBILE-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/mobile-routes/

Retrieve operation of resource: mobile-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

mobile-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

SUBSCRIBER-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/subscriber-routes/

Update operation of resource: subscriber-routes

subscriber-routes_schema

subscriber-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SUBSCRIBER-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/subscriber-routes/

Create operation of resource: subscriber-routes

subscriber-routes_schema

subscriber-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

Request Content-Types: application/json

Request Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SUBSCRIBER-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/subscriber-routes/

Delete operation of resource: subscriber-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SUBSCRIBER-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-afs/global-af/{af-name}/subscriber-routes/

Retrieve operation of resource: subscriber-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

af-name

in path

string

ID of af-name

200 OK

subscriber-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

RPKI-STATIC-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-static-routes/

Update operation of resource: rpki-static-routes

rpki-static-routes_schema

rpki-static-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "rpki-static-route": [
    {
      "addrress": "string",
      "as": "integer",
      "minimum": "integer",
      "maximum": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPKI-STATIC-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-static-routes/

Create operation of resource: rpki-static-routes

rpki-static-routes_schema

rpki-static-routesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "rpki-static-route": [
    {
      "addrress": "string",
      "as": "integer",
      "minimum": "integer",
      "maximum": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPKI-STATIC-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-static-routes/

Delete operation of resource: rpki-static-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPKI-STATIC-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-static-routes/

Retrieve operation of resource: rpki-static-routes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

rpki-static-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "rpki-static-route": [
    {
      "addrress": "string",
      "as": "integer",
      "minimum": "integer",
      "maximum": "integer"
    }
  ]
}

RPKI-STATIC-ROUTE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-static-routes/rpki-static-route/{addrress minimum maximum as}/

Update operation of resource: rpki-static-route

rpki-static-route_schema

rpki-static-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

addrress minimum maximum as

in path

string

ID of addrress minimum maximum as

Request Content-Types: application/json

Request Example

{
  "addrress": "string",
  "as": "integer",
  "minimum": "integer",
  "maximum": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPKI-STATIC-ROUTE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-static-routes/rpki-static-route/{addrress minimum maximum as}/

Create operation of resource: rpki-static-route

rpki-static-route_schema

rpki-static-routebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

addrress minimum maximum as

in path

string

ID of addrress minimum maximum as

Request Content-Types: application/json

Request Example

{
  "addrress": "string",
  "as": "integer",
  "minimum": "integer",
  "maximum": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPKI-STATIC-ROUTE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-static-routes/rpki-static-route/{addrress minimum maximum as}/

Delete operation of resource: rpki-static-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

addrress minimum maximum as

in path

string

ID of addrress minimum maximum as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPKI-STATIC-ROUTE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/rpki-static-routes/rpki-static-route/{addrress minimum maximum as}/

Retrieve operation of resource: rpki-static-route

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

addrress minimum maximum as

in path

string

ID of addrress minimum maximum as

200 OK

rpki-static-route_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "addrress": "string",
  "as": "integer",
  "minimum": "integer",
  "maximum": "integer"
}

MPLS-ACTIVATED-INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/mpls-activated-interfaces/

Update operation of resource: mpls-activated-interfaces

mpls-activated-interfaces_schema

mpls-activated-interfacesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "mpls-activated-interface": [
    {
      "interface-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-ACTIVATED-INTERFACES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/mpls-activated-interfaces/

Create operation of resource: mpls-activated-interfaces

mpls-activated-interfaces_schema

mpls-activated-interfacesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "mpls-activated-interface": [
    {
      "interface-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-ACTIVATED-INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/mpls-activated-interfaces/

Delete operation of resource: mpls-activated-interfaces

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-ACTIVATED-INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/mpls-activated-interfaces/

Retrieve operation of resource: mpls-activated-interfaces

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

mpls-activated-interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "mpls-activated-interface": [
    {
      "interface-name": "string"
    }
  ]
}

MPLS-ACTIVATED-INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/mpls-activated-interfaces/mpls-activated-interface/{interface-name}/

Update operation of resource: mpls-activated-interface

mpls-activated-interface_schema

mpls-activated-interfacebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

interface-name

in path

string

ID of interface-name

Request Content-Types: application/json

Request Example

{
  "interface-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-ACTIVATED-INTERFACE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/mpls-activated-interfaces/mpls-activated-interface/{interface-name}/

Create operation of resource: mpls-activated-interface

mpls-activated-interface_schema

mpls-activated-interfacebody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

interface-name

in path

string

ID of interface-name

Request Content-Types: application/json

Request Example

{
  "interface-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-ACTIVATED-INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/mpls-activated-interfaces/mpls-activated-interface/{interface-name}/

Delete operation of resource: mpls-activated-interface

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

interface-name

in path

string

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-ACTIVATED-INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/mpls-activated-interfaces/mpls-activated-interface/{interface-name}/

Retrieve operation of resource: mpls-activated-interface

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

interface-name

in path

string

ID of interface-name

200 OK

mpls-activated-interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "interface-name": "string"
}

GLOBAL-TIMERS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-timers/

Update operation of resource: global-timers

global-timers_schema

global-timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "hold-time": "integer",
  "keepalive": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-TIMERS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-timers/

Create operation of resource: global-timers

global-timers_schema

global-timersbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "min-accept-hold-time": "integer",
  "hold-time": "integer",
  "keepalive": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-TIMERS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-timers/

Delete operation of resource: global-timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-TIMERS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/global-timers/

Retrieve operation of resource: global-timers

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

global-timers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "min-accept-hold-time": "integer",
  "hold-time": "integer",
  "keepalive": "integer"
}

BFD - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/bfd/

Update operation of resource: bfd

bfd_schema

bfdbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "detection-multiplier": "integer",
  "interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/bfd/

Create operation of resource: bfd

bfd_schema

bfdbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "detection-multiplier": "integer",
  "interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/bfd/

Delete operation of resource: bfd

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/bfd/

Retrieve operation of resource: bfd

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

bfd_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "detection-multiplier": "integer",
  "interval": "integer"
}

SEND-SOCKET-BUFFER-SIZES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/send-socket-buffer-sizes/

Update operation of resource: send-socket-buffer-sizes

send-socket-buffer-sizes_schema

send-socket-buffer-sizesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-SOCKET-BUFFER-SIZES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/send-socket-buffer-sizes/

Create operation of resource: send-socket-buffer-sizes

send-socket-buffer-sizes_schema

send-socket-buffer-sizesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-SOCKET-BUFFER-SIZES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/send-socket-buffer-sizes/

Delete operation of resource: send-socket-buffer-sizes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SEND-SOCKET-BUFFER-SIZES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/send-socket-buffer-sizes/

Retrieve operation of resource: send-socket-buffer-sizes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

send-socket-buffer-sizes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

RECEIVE-SOCKET-BUFFER-SIZES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/receive-socket-buffer-sizes/

Update operation of resource: receive-socket-buffer-sizes

receive-socket-buffer-sizes_schema

receive-socket-buffer-sizesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-SOCKET-BUFFER-SIZES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/receive-socket-buffer-sizes/

Create operation of resource: receive-socket-buffer-sizes

receive-socket-buffer-sizes_schema

receive-socket-buffer-sizesbody object

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

Request Content-Types: application/json

Request Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-SOCKET-BUFFER-SIZES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/receive-socket-buffer-sizes/

Delete operation of resource: receive-socket-buffer-sizes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECEIVE-SOCKET-BUFFER-SIZES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/default-vrf/global/receive-socket-buffer-sizes/

Retrieve operation of resource: receive-socket-buffer-sizes

instance-name

in path

string

ID of instance-name

in path

string

ID of as

our-byte-as_as

in path

string

ID of our-byte-as_as

200 OK

receive-socket-buffer-sizes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

BMP-SERVER-ALL - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bmp-server-all/

Update operation of resource: bmp-server-all

bmp-server-all_schema

bmp-server-allbody object

Request Content-Types: application/json

Request Example

{
  "maximum-buffer-size": "integer",
  "route-monitoring": {
    "policy": "string",
    "direction": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-SERVER-ALL - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bmp-server-all/

Create operation of resource: bmp-server-all

bmp-server-all_schema

bmp-server-allbody object

Request Content-Types: application/json

Request Example

{
  "maximum-buffer-size": "integer",
  "route-monitoring": {
    "policy": "string",
    "direction": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-SERVER-ALL - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bmp-server-all/

Delete operation of resource: bmp-server-all

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-SERVER-ALL - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bmp-server-all/

Retrieve operation of resource: bmp-server-all

200 OK

bmp-server-all_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "maximum-buffer-size": "integer",
  "route-monitoring": {
    "policy": "string",
    "direction": "string"
  }
}

ROUTE-MONITORING - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bmp-server-all/route-monitoring/

Update operation of resource: route-monitoring

route-monitoring_schema

route-monitoringbody object

Request Content-Types: application/json

Request Example

{
  "policy": "string",
  "direction": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-MONITORING - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bmp-server-all/route-monitoring/

Create operation of resource: route-monitoring

route-monitoring_schema

route-monitoringbody object

Request Content-Types: application/json

Request Example

{
  "policy": "string",
  "direction": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-MONITORING - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bmp-server-all/route-monitoring/

Delete operation of resource: route-monitoring

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-MONITORING - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bmp-server-all/route-monitoring/

Retrieve operation of resource: route-monitoring

200 OK

route-monitoring_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "policy": "string",
  "direction": "string"
}

BMP-SERVERS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/

Update operation of resource: bmp-servers

bmp-servers_schema

bmp-serversbody object

Request Content-Types: application/json

Request Example

{
  "bmp-server": [
    {
      "host-port": {
        "host": "string",
        "port": "string"
      },
      "initial-refresh-delay": {
        "delay": "integer",
        "skip": [ null ],
        "spread": "integer"
      },
      "status-report-interval": "integer",
      "description": "string",
      "tos": {
        "type": "string",
        "value": "string"
      },
      "create": [ null ],
      "server-id": "integer",
      "bmptcp-keep-alive": "integer",
      "maximum-buffer-size": "integer",
      "initial-delay": "integer",
      "vrf": "string",
      "shutdown": [ null ],
      "update-source-interface": "string",
      "bmptcp-maximum-segment-size": "integer",
      "flapping-delay": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-SERVERS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/

Create operation of resource: bmp-servers

bmp-servers_schema

bmp-serversbody object

Request Content-Types: application/json

Request Example

{
  "bmp-server": [
    {
      "host-port": {
        "host": "string",
        "port": "string"
      },
      "initial-refresh-delay": {
        "delay": "integer",
        "skip": [ null ],
        "spread": "integer"
      },
      "status-report-interval": "integer",
      "description": "string",
      "tos": {
        "type": "string",
        "value": "string"
      },
      "create": [ null ],
      "server-id": "integer",
      "bmptcp-keep-alive": "integer",
      "maximum-buffer-size": "integer",
      "initial-delay": "integer",
      "vrf": "string",
      "shutdown": [ null ],
      "update-source-interface": "string",
      "bmptcp-maximum-segment-size": "integer",
      "flapping-delay": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-SERVERS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/

Delete operation of resource: bmp-servers

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-SERVERS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/

Retrieve operation of resource: bmp-servers

200 OK

bmp-servers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "bmp-server": [
    {
      "host-port": {
        "host": "string",
        "port": "string"
      },
      "initial-refresh-delay": {
        "delay": "integer",
        "skip": [ null ],
        "spread": "integer"
      },
      "status-report-interval": "integer",
      "description": "string",
      "tos": {
        "type": "string",
        "value": "string"
      },
      "create": [ null ],
      "server-id": "integer",
      "bmptcp-keep-alive": "integer",
      "maximum-buffer-size": "integer",
      "initial-delay": "integer",
      "vrf": "string",
      "shutdown": [ null ],
      "update-source-interface": "string",
      "bmptcp-maximum-segment-size": "integer",
      "flapping-delay": "integer"
    }
  ]
}

BMP-SERVER - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/

Update operation of resource: bmp-server

bmp-server_schema

bmp-serverbody object

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "host-port": {
    "host": "string",
    "port": "string"
  },
  "initial-refresh-delay": {
    "delay": "integer",
    "skip": [ null ],
    "spread": "integer"
  },
  "status-report-interval": "integer",
  "description": "string",
  "tos": {
    "type": "string",
    "value": "string"
  },
  "create": [ null ],
  "server-id": "integer",
  "bmptcp-keep-alive": "integer",
  "maximum-buffer-size": "integer",
  "initial-delay": "integer",
  "vrf": "string",
  "shutdown": [ null ],
  "update-source-interface": "string",
  "bmptcp-maximum-segment-size": "integer",
  "flapping-delay": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-SERVER - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/

Create operation of resource: bmp-server

bmp-server_schema

bmp-serverbody object

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "host-port": {
    "host": "string",
    "port": "string"
  },
  "initial-refresh-delay": {
    "delay": "integer",
    "skip": [ null ],
    "spread": "integer"
  },
  "status-report-interval": "integer",
  "description": "string",
  "tos": {
    "type": "string",
    "value": "string"
  },
  "create": [ null ],
  "server-id": "integer",
  "bmptcp-keep-alive": "integer",
  "maximum-buffer-size": "integer",
  "initial-delay": "integer",
  "vrf": "string",
  "shutdown": [ null ],
  "update-source-interface": "string",
  "bmptcp-maximum-segment-size": "integer",
  "flapping-delay": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-SERVER - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/

Delete operation of resource: bmp-server

server-id

in path

string

ID of server-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BMP-SERVER - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/

Retrieve operation of resource: bmp-server

server-id

in path

string

ID of server-id

200 OK

bmp-server_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "host-port": {
    "host": "string",
    "port": "string"
  },
  "initial-refresh-delay": {
    "delay": "integer",
    "skip": [ null ],
    "spread": "integer"
  },
  "status-report-interval": "integer",
  "description": "string",
  "tos": {
    "type": "string",
    "value": "string"
  },
  "create": [ null ],
  "server-id": "integer",
  "bmptcp-keep-alive": "integer",
  "maximum-buffer-size": "integer",
  "initial-delay": "integer",
  "vrf": "string",
  "shutdown": [ null ],
  "update-source-interface": "string",
  "bmptcp-maximum-segment-size": "integer",
  "flapping-delay": "integer"
}

INITIAL-REFRESH-DELAY - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/initial-refresh-delay/

Update operation of resource: initial-refresh-delay

initial-refresh-delay_schema

initial-refresh-delaybody object

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "delay": "integer",
  "skip": [ null ],
  "spread": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INITIAL-REFRESH-DELAY - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/initial-refresh-delay/

Create operation of resource: initial-refresh-delay

initial-refresh-delay_schema

initial-refresh-delaybody object

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "delay": "integer",
  "skip": [ null ],
  "spread": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INITIAL-REFRESH-DELAY - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/initial-refresh-delay/

Delete operation of resource: initial-refresh-delay

server-id

in path

string

ID of server-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INITIAL-REFRESH-DELAY - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/initial-refresh-delay/

Retrieve operation of resource: initial-refresh-delay

server-id

in path

string

ID of server-id

200 OK

initial-refresh-delay_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "delay": "integer",
  "skip": [ null ],
  "spread": "integer"
}

HOST-PORT - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/host-port/

Update operation of resource: host-port

host-port_schema

host-portbody object

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "host": "string",
  "port": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST-PORT - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/host-port/

Create operation of resource: host-port

host-port_schema

host-portbody object

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "host": "string",
  "port": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST-PORT - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/host-port/

Delete operation of resource: host-port

server-id

in path

string

ID of server-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST-PORT - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/host-port/

Retrieve operation of resource: host-port

server-id

in path

string

ID of server-id

200 OK

host-port_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "host": "string",
  "port": "string"
}

TOS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/tos/

Update operation of resource: tos

tos_schema

tosbody object

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/tos/

Create operation of resource: tos

tos_schema

tosbody object

server-id

in path

string

ID of server-id

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/tos/

Delete operation of resource: tos

server-id

in path

string

ID of server-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bmp-servers/bmp-server/{server-id}/tos/

Retrieve operation of resource: tos

server-id

in path

string

ID of server-id

200 OK

tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "type": "string",
  "value": "string"
}

Schema Definitions

EBGP-RECV-DMZ:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

ebgp-recv-dmz: boolean: TRUE to receive DMZ link bandwidth from ebgp peer. FALSE to not receive from ebgp peer and to prevent inheritance from a parent

Example

{
  "ebgp-recv-dmz": "boolean"
}

ENABLE:

Common node of global-af, vrf-global-af

enable: null: Enable the address family. Deletion of this object causes deletion of all the objects under GlobalAF/VRFGlobalAF associated with this object .

Example

{
  "enable": [ null ]
}

AS-OVERRIDE:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

as-override: boolean: TRUE to override matching AS-number while sending update. FALSE to prevent as-override from being inherited from the parent

Example

{
  "as-override": "boolean"
}

IGNORE-CONNECTED-CHECK-EBGP:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-afCommon node of neighbor-group, neighbor, vrf-neighbor, session-group

ignore-connected-check-ebgp: boolean: TRUE to disable the connected nexthop check for this peer.FALSE to enable the connected nexthop check for this peer.

Example

{
  "ignore-connected-check-ebgp": "boolean"
}

SUBSCRIBER-ROUTES:

Common node of global-af, vrf-global-af

subscriber-routes: object: Redistribute subscriber routes

Example

{
  "subscriber-routes": {
    "default-metric": "string",
    "route-policy-name": "string",
    "not-used": "integer"
  }
}

TTL-SECURITY:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

ttl-security: boolean: TRUE to enable BGP TTL Security. FALSE to not enable it and to prevent inheritance from a parent

Example

{
  "ttl-security": "boolean"
}

PROPAGATE-DMZ-LINK-BANDWIDTH:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

propagate-dmz-link-bandwidth: boolean: TRUE to propagate DMZ link bandwidth. FALSE to not propagate and to prevent inheritance from a parent

Example

{
  "propagate-dmz-link-bandwidth": "boolean"
}

NEXT-HOP-RES-ALLOW-DEFAULT:

Common node of neighbor-group, neighbor, vrf-neighbor, session-groupCommon node of global, vrf-global

next-hop-res-allow-default: null: Enable path resolution for nexthops using default route

Example

{
  "next-hop-res-allow-default": [ null ]
}

GLOBAL-TIMERS:

Common node of global, vrf-global

global-timers: object: Adjust routing timers.

Example

{
  "global-timers": {
    "min-accept-hold-time": "integer",
    "hold-time": "integer",
    "keepalive": "integer"
  }
}

ATTRIBUTE-DOWNLOAD:

Common node of global-af, vrf-global-af

attribute-download: null: Attribute download configuration

Example

{
  "attribute-download": [ null ]
}

BGP-CFG-RPKI-ORIGIN-AS-VALIDATION-DISABLE:

Common node of neighbor-group-af, neighbor-af, af-group-afCommon node of neighbor-group, neighbor, session-group

rpki-origin-as-validation-disable: null: RPKI origin-AS validation disable

Example

{
  "rpki-origin-as-validation-disable": [ null ]
}

LABEL-MODE:

Common node of global-af, vrf-global-af

label-mode: object: BGP 6PE/MPLS-VPN label allocation mode

Example

{
  "label-mode": {
    "route-policy-name": "string",
    "label-allocation-mode": "string"
  }
}

KEYCHAIN:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

keychain: object: Set or disable keychain based authentication

Example

{
  "keychain": {
    "keychain-name": "string",
    "keychain-disable": "boolean"
  }
}

ADVERTISE-VRF-IMP-DISABLE-V6:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-vrf-imp-disable-v6: object: Disable Advertise Of VRF ReImported Routes

Example

{
  "advertise-vrf-imp-disable-v6": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

MULTI-PATH-AS-PATH-IGNORE-ONWARDS:

Common node of global, vrf-global

multi-path-as-path-ignore-onwards: null: Change default multi-route selection criteria to ignore everything onwards as-path check

Example

{
  "multi-path-as-path-ignore-onwards": [ null ]
}

ADVERTISE-DEF-IMP-DISABLE-V6:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-def-imp-disable-v6: object: Disable Advertise Of Default VRF Imported Routes

Example

{
  "advertise-def-imp-disable-v6": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

ADVERTISE-DEF-IMP-DISABLE-V4:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-def-imp-disable-v4: object: Disable Advertise Of Default VRF Imported Routes

Example

{
  "advertise-def-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

NEXT-HOP-UNCHANGED-MULTIPATH:

Common node of neighbor-group, neighbor, vrf-neighbor, session-groupCommon node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

next-hop-unchanged-multipath: boolean: TRUE to disable overwriting of next hop for multipaths. FALSE to prevent next-hop-unchanged for multipaths.

Example

{
  "next-hop-unchanged-multipath": "boolean"
}

OPTIMAL-ROUTE-REFLECTOR-GROUP-TABLE:

Common node of global-af, vrf-global-af

optimal-route-reflector-groups: object: Table of multiple ORR groups

Example

{
  "optimal-route-reflector-groups": {
    "optimal-route-reflector-group": [
      {
        "primary-root-address": "string",
        "group-name": "string",
        "tertiary-root-address": "string",
        "secondary-root-address": "string"
      }
    ]
  }
}

ADVERTISE-PERMANENT-NETWORK:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-permanent-network: null: Advertise Permanent Networks to the peer

Example

{
  "advertise-permanent-network": [ null ]
}

BEST-PATH-IGP-METRIC-IGNORE:

Common node of global, vrf-global

best-path-igp-metric-ignore: null: Change default route selection criteria to ignore IGP Metric

Example

{
  "best-path-igp-metric-ignore": [ null ]
}

BEST-PATH-COST-COMMUNITY:

Common node of global, vrf-global

best-path-cost-community: null: Change default route selection criteria to ignore cost community comparison

Example

{
  "best-path-cost-community": [ null ]
}

IMPORT:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

import: object: Import Reorigination options for Routes from the peer

Example

{
  "import": {
    "import-reoriginate": "boolean",
    "import-stitching": "boolean",
    "import-reoriginate-stitching": "boolean"
  }
}

EBGP-SEND-DMZ-ENABLE-MODES:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

ebgp-send-dmz-enable-modes: string disable, default, cumulative: Default mode, Cumulative mode or Disable to prevent inheritance from a parent

Example

{
  "ebgp-send-dmz-enable-modes": "string"
}

AIGP:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

aigp: string enable, disable: Enable Accumulated IGP Metric for this neighbor.

Example

{
  "aigp": "string"
}

SEND-SOCKET-BUFFER-SIZES:

Common node of global, vrf-global

send-socket-buffer-sizes: object: set socket parameters

Example

{
  "send-socket-buffer-sizes": {
    "bgp-send-size": "integer",
    "socket-send-size": "integer"
  }
}

DAMPENING:

Common node of global-af, vrf-global-af

dampening: object: Enable route-flap dampening

Example

{
  "dampening": {
    "reuse-threshold": "integer",
    "half-life": "integer",
    "suppress-time": "integer",
    "suppress-threshold": "integer",
    "route-policy-name": "string"
  }
}

BFD:

Common node of global, vrf-global

bfd: object: BFD configuration

Example

{
  "bfd": {
    "detection-multiplier": "integer",
    "interval": "integer"
  }
}

ENCAPSULATION-TYPE:

Common node of neighbor-group-af, neighbor-af, af-group-afCommon node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

encapsulation-type: string vx-lan: Encapsulation type for this neighbor

Example

{
  "encapsulation-type": "string"
}

SRV6-LABEL-ALLOCATION-MODE:

Common node of global-af, vrf-global-af

srv6-label-allocation-mode: string: Label allocation mode: per-ce Set per CE label mode,per-vrf Set per VRF label mode

Example

{
  "srv6-label-allocation-mode": "string"
}

AO-KEYCHAIN:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

ao-keychain: object: Set or disable AO based authentication

Example

{
  "ao-keychain": {
    "ao-keychain-disable": "boolean",
    "ao-include-tcp-options": "boolean",
    "ao-accept-mismatch-connection": "boolean",
    "ao-keychain-name": "string"
  }
}

SEND-EXT-COMMUNITY-EBGP:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

send-ext-community-ebgp: boolean: TRUE to send extended communities to the external neighbor/neighbor-group/af-group. FALSE not to send and to prevent inheritance from a parent

Example

{
  "send-ext-community-ebgp": "boolean"
}

ADVERTISE-LOCAL-LABELED-ROUTE-SAFI-UNICAST:

Common node of global-af, vrf-global-af

advertise-local-labeled-route-safi-unicast: string enable, disable: Enable/disable advertisement of routes with local-label via Unicast SAFI

Example

{
  "advertise-local-labeled-route-safi-unicast": "string"
}

UPDATE-SOURCE-INTERFACE:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

update-source-interface: string: Select an interface to configure

Example

{
  "update-source-interface": "string"
}

AF-GROUP:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af

af-group: string: Inherit configuration for this address-family from an AF-group

Example

{
  "af-group": "string"
}

DISABLE-ENFORCE-FIRST-AS:

Common node of global, vrf-global

disable-enforce-first-as: null: Disable enforce the first AS for EBGP routes

Example

{
  "disable-enforce-first-as": [ null ]
}

ROUTE-POLICY-OUT:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

route-policy-out: string: Route policy name to apply to outbound routes

Example

{
  "route-policy-out": "string"
}

FLOWSPEC-VALIDATION:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

flowspec-validation: string enable, disable, redirect-nexhop-disable: Config Flowspec validation for this neighbor

Example

{
  "flowspec-validation": "string"
}

ADDITIONAL-PATHS-SEND:

Common node of global-af, vrf-global-af

additional-paths-send: string enable, disable: Advertise additional paths Send capability

Example

{
  "additional-paths-send": "string"
}

ROUTE-POLICY-IN:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

route-policy-in: string: Route policy name to apply to inbound routes

Example

{
  "route-policy-in": "string"
}

ADDITIONAL-PATHS-RECEIVE:

Common node of global-af, vrf-global-af

additional-paths-receive: string enable, disable: Advertise additional paths Receive capability

Example

{
  "additional-paths-receive": "string"
}

ACCEPT-OWN:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

accept-own: boolean: Handle self-originated routes with Accept-Own community. Valid for following neighbor address-families: VPNv4Unicast, VPNv6Unicast.

Example

{
  "accept-own": "boolean"
}

ADVERTISE-LOCAL-V6:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-local-v6: object: Advertise Of Local Routes to the peer with different RT

Example

{
  "advertise-local-v6": {
    "af-name": "string",
    "rt-type": "string",
    "reorg-option": "string"
  }
}

DISABLE-FAST-EXTERNAL-FALLOVER:

Common node of global, vrf-global

disable-fast-external-fallover: null: Disable immediate reset session if a link to a directly connected external peer goes down

Example

{
  "disable-fast-external-fallover": [ null ]
}

ADVERTISE-LOCAL-V4:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-local-v4: object: Advertise Of Local Routes to the peer with different RT

Example

{
  "advertise-local-v4": {
    "af-name": "string",
    "rt-type": "string",
    "reorg-option": "string"
  }
}

TIMERS:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

timers: object: BGP per neighbor timers.

Example

{
  "timers": {
    "min-accept-hold-time": "integer",
    "keepalive-interval": "integer",
    "hold-time": "integer"
  }
}

AIGP-SEND-MED:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

aigp-send-med: string enable, disable: Enable/Disable sending AIGP in MED

Example

{
  "aigp-send-med": "string"
}

ROUTE-TARGET-TABLE:

Common node of import-route-targets, export-route-targets

route-targets: object: Route target table

Example

{
  "route-targets": {
    "route-target": [
      {
        "as-or-four-byte-as": [
          {
            "as-xx": "integer",
            "as": "integer",
            "stitching-rt": "integer",
            "as-index": "string"
          }
        ],
        "ipv4-address": [
          {
            "address-index": "string",
            "stitching-rt": "integer",
            "address": "string"
          }
        ],
        "type": "string"
      }
    ]
  }
}

DISABLE-AS-PATH-LOOP-CHECK:

Common node of global-af, vrf-global-af

disable-as-path-loop-check: null: Disable outbound AS Path loop check

Example

{
  "disable-as-path-loop-check": [ null ]
}

NEXT-HOP-UNCHANGED:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

next-hop-unchanged: boolean: TRUE to disable overwriting of next hop before advertising to eBGP peers. FALSE to prevent next-hop-unchanged from being inherited.

Example

{
  "next-hop-unchanged": "boolean"
}

ENFORCE-MULTIPLE-LABELS:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

enforce-multiple-labels: boolean: TRUE to enforce multiple labels support.

Example

{
  "enforce-multiple-labels": "boolean"
}

NEXT-HOP-MPLS-FWD-IBGP:

Common node of global, vrf-global

next-hop-mpls-fwd-ibgp: null: Enable mpls forwarding path for ibgp learnt nexthops

Example

{
  "next-hop-mpls-fwd-ibgp": [ null ]
}

RPKI-BESTPATH-ORIGIN-AS-ALLOW-INVALID:

Common node of neighbor-group-af, neighbor-af, af-group-af

rpki-bestpath-origin-as-allow-invalid: null: RPKI bestpath origin-AS allow invalid

Example

{
  "rpki-bestpath-origin-as-allow-invalid": [ null ]
}

ADVERTISE-DISABLE:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-disable: object: Disable Advertise Of Routes to the peer

Example

{
  "advertise-disable": {
    "af-name": "string",
    "rt-type": "string",
    "reorg-option": "string"
  }
}

SEND-BUFFER-SIZE:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

send-buffer-size: object: Set socket send buffer size and BGP write buffer size

Example

{
  "send-buffer-size": {
    "bgp-send-size": "integer",
    "socket-send-size": "integer"
  }
}

LOCAL-PREFERENCE:

Common node of global, vrf-global

local-preference: integer: Configure default local preference
range:"0..4294967295" default:local preference"

Example

{
  "local-preference": "integer"
}

BEST-PATH-ROUTER-ID:

Common node of global, vrf-global

best-path-router-id: null: Change default route selection criteria and compare router-id for identical EBGP paths

Example

{
  "best-path-router-id": [ null ]
}

BGP-CFG-RPKI-BESTPATH-ORIGIN-AS-ALLOW-INVALID:

Common node of neighbor-group-af, neighbor-af, af-group-afCommon node of neighbor-group, neighbor, session-group

rpki-bestpath-origin-as-allow-invalid: null: RPKI bestpath origin-AS allow invalid

Example

{
  "rpki-bestpath-origin-as-allow-invalid": [ null ]
}

IGP-REDIST-INTERNAL:

Common node of global, vrf-global

igp-redist-internal: null: Allow redistribution of iBGP into IGPs (dangerous)

Example

{
  "igp-redist-internal": [ null ]
}

ADVERTISEMENT-INTERVAL:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

advertisement-interval: object: Minimum interval between sending BGP routing updates

Example

{
  "advertisement-interval": {
    "minimum-interval-msecs": "integer",
    "minimum-interval": "integer"
  }
}

ACTIVATE:

Common node of neighbor-af, vrf-neighbor-af, neighbor-group-af

activate: null: Activate an address family for this neighbor. Deletion of this object causes deletion of all the objects under NeighborAF/VRFNeighborAF/NeighborGroupAF associated with this object.

Example

{
  "activate": [ null ]
}

STATIC-ROUTES:

Common node of global-af, vrf-global-af

static-routes: object: Redistribute static routes

Example

{
  "static-routes": {
    "default-metric": "string",
    "route-policy-name": "string",
    "not-used": "integer"
  }
}

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-CAPABLE:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

neighbor-af-long-lived-graceful-restart-capable: boolean: TRUE to treat neighbor as Long-lived Graceful-restart capable. FALSE to rely on capability negotiation.

Example

{
  "neighbor-af-long-lived-graceful-restart-capable": "boolean"
}

AIGP-COST-COMMUNITY:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

aigp-cost-community: object: Send AIGP value in Cost Community.

Example

{
  "aigp-cost-community": {
    "enable": "boolean",
    "cost-community-poi-type": "string",
    "cost-community-id": "integer",
    "transitive": "boolean"
  }
}

DEFAULT-INFO-ORIGINATE:

Common node of global, vrf-global

default-info-originate: null: Control distribution of default information

Example

{
  "default-info-originate": [ null ]
}

BEST-PATH-AS-PATH-LENGTH:

Common node of global, vrf-global

best-path-as-path-length: null: Change default route selection criteria to ignore AS path length

Example

{
  "best-path-as-path-length": [ null ]
}

ADVERTISE-LOCAL-LABELED-ROUTE:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-local-labeled-route: string enable, disable: Enable/disable advertisement of routes with local-label

Example

{
  "advertise-local-labeled-route": "string"
}

DISTANCE:

Common node of global-af, vrf-global-af

distance: object: Define an administrative distance

Example

{
  "distance": {
    "external-routes": "integer",
    "local-routes": "integer",
    "internal-routes": "integer"
  }
}

ADVERTISE-V6:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-v6: object: Advertise Translated Routes to the peer

Example

{
  "advertise-v6": {
    "af-name": "string",
    "rt-type": "string",
    "reorg-option": "string"
  }
}

SUPPRESS-FOUR-BYTE-AS-CAPABILITY:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

suppress-four-byte-as-capability: boolean: TRUE to suppress BGP 4-byte-as capability. FALSE to not suppress it and to prevent inheritance from a parent

Example

{
  "suppress-four-byte-as-capability": "boolean"
}

ADVERTISE-V4:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-v4: object: Advertise Translated Routes to the peer

Example

{
  "advertise-v4": {
    "af-name": "string",
    "rt-type": "string",
    "reorg-option": "string"
  }
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

remove-private-as-entire-as-path: object: Remove private AS number from outbound updates

Example

{
  "remove-private-as-entire-as-path": {
    "entire": "boolean",
    "enable": "boolean"
  }
}

ADVERTISE-VRF-IMP-DISABLE-V4:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-vrf-imp-disable-v4: object: Disable Advertise Of VRF ReImported Routes

Example

{
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

TCPMSS:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

tcpmss: object: TCP Maximum segment size

Example

{
  "tcpmss": {
    "tcpmss-disable": "boolean",
    "mss": "integer"
  }
}

SEND-COMMUNITY-EBGP-GRACEFUL-SHUTDOWN:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

send-community-ebgp-graceful-shutdown: boolean: TRUE to send communities to the external neighbor/neighbor-group/af-group. FALSE not to send and to prevent inheritance from a parent

Example

{
  "send-community-ebgp-graceful-shutdown": "boolean"
}

UNSAFE-EBGP-POLICY:

Common node of global, vrf-global

unsafe-ebgp-policy: null: If eBGP neighbor is configured without a route-policy,the routes from that neighbor are not accepted by default.This knob overrides the default behavior. When configured,routes from the eBGP neighbors with no policy are accepted.

Example

{
  "unsafe-ebgp-policy": [ null ]
}

ADVERTISE-LOCAL-L2VPN-EVPN:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-local-l2vpn-evpn: object: Advertise Of Local Routes to the peer with different RT

Example

{
  "advertise-local-l2vpn-evpn": {
    "af-name": "string",
    "rt-type": "string",
    "reorg-option": "string"
  }
}

DEFAULT-METRIC:

Common node of global, vrf-global

default-metric: integer: Default redistributed metric
range:"1..4294967295"

Example

{
  "default-metric": "integer"
}

LOCAL-ADDRESS:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

local-address: object: Local ip address

Example

{
  "local-address": {
    "local-address-disable": "boolean",
    "local-ip-address": "string"
  }
}

DYNAMIC-MED-INTERVAL:

Common node of global-af, vrf-global-af

dynamic-med-interval: integer: Update generation delay (in minutes) after a MED change
range:"0..10" units:"minute" default:"10"

Example

{
  "dynamic-med-interval": "integer"
}

ALLOCATE-LABEL:

Common node of global-af, vrf-global-af

allocate-label: object: Label allocation policy

Example

{
  "allocate-label": {
    "all": "boolean",
    "route-policy-name": "string",
    "un-labeled-path": "boolean"
  }
}

OSPF-ROUTE-TABLE:

Common node of global-af, vrf-global-af

ospf-routes: object: Redistribute information for OSPF routes.

Example

{
  "ospf-routes": {
    "ospf-route": [
      {
        "default-metric": "string",
        "route-policy-name": "string",
        "redist-type": "string",
        "instance-name": "string"
      }
    ]
  }
}

SOFT-RECONFIGURATION:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

soft-reconfiguration: object: Enable/disable inbound soft reconfiguration for this neighbor/neighbor-group/af-group

Example

{
  "soft-reconfiguration": {
    "soft-always": "boolean",
    "inbound-soft": "boolean"
  }
}

MSG-LOG-OUT:

Common node of global, vrf-globalCommon node of neighbor-group, neighbor, vrf-neighbor, session-group

msg-log-out: object: Message log outbound

Example

{
  "msg-log-out": {
    "msg-log-inherit-disable": "boolean",
    "msg-log-disable": "boolean",
    "msg-buf-count": "integer"
  }
}

REMOVE-PRIVATE-AS-ENTIRE-AS-PATH-INBOUND:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

remove-private-as-entire-as-path-inbound: object: Remove private AS number from inbound updates

Example

{
  "remove-private-as-entire-as-path-inbound": {
    "entire": "boolean",
    "enable": "boolean"
  }
}

MAX-PEERS:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

max-peers: integer: Set Maximum Peers in Dynamic Range
range:"1..4096"

Example

{
  "max-peers": "integer"
}

GRACEFUL-MAINTENANCE:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

graceful-maintenance: object: Graceful Maintenance mode

Example

{
  "graceful-maintenance": {
    "enable": [ null ],
    "graceful-maintenance-local-preference": {
      "local-preference": "integer",
      "gshut-loc-pref-disable": "boolean"
    },
    "graceful-maintenance-activate": "boolean",
    "graceful-maintenance-as-prepends": {
      "gshut-prepends-disable": "boolean",
      "as-prepends": "integer"
    }
  }
}

MPLS-ACTIVATED-INTERFACE-TABLE:

Common node of global, vrf-global

mpls-activated-interfaces: object: Configure list of MPLS activated interfaces

Example

{
  "mpls-activated-interfaces": {
    "mpls-activated-interface": [
      {
        "interface-name": "string"
      }
    ]
  }
}

LISP-ROUTES:

Common node of global-af, vrf-global-af

lisp-routes: object: Redistribute lisp routes

Example

{
  "lisp-routes": {
    "default-metric": "string",
    "route-policy-name": "string"
  }
}

DISABLE-NEIGHBOR-LOGGING:

Common node of global, vrf-global

disable-neighbor-logging: null: Disable neighbor change logging

Example

{
  "disable-neighbor-logging": [ null ]
}

RPKI-ORIGIN-AS-VALIDATION-DISABLE:

Common node of neighbor-group-af, neighbor-af, af-group-af

rpki-origin-as-validation-disable: null: RPKI origin-AS validation disable

Example

{
  "rpki-origin-as-validation-disable": [ null ]
}

BFD-MULTIPLIER:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

bfd-multiplier: integer: Detection multiplier for BFD sessions created by BGP
range:"2..16"

Example

{
  "bfd-multiplier": "integer"
}

BMP-ACTIVATE-TABLE:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

bmp-activates: object: Enable BMP logging for this neighbor

Example

{
  "bmp-activates": {
    "bmp-activate": [
      {
        "server-id": "integer"
      }
    ]
  }
}

NEXT-HOP-SELF:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

next-hop-self: boolean: Disable the next hop calculation and insert your own address in the nexthop field of advertised routes you learned from the neighbor.

Example

{
  "next-hop-self": "boolean"
}

NEXT-HOP-RESOLUTION-PREFIX-LENGTH-MINIMUM:

Common node of global-af, vrf-global-af

next-hop-resolution-prefix-length-minimum: integer: Minimum prefix-length for nexthop resolution
range:"0..128" default:"0"

Example

{
  "next-hop-resolution-prefix-length-minimum": "integer"
}

REMOTE-AS:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

remote-as: object: Set remote AS

Example

{
  "remote-as": {
    "as-xx": "string",
    "as-yy": "string"
  }
}

MAXIMUM-PREFIXES:

Common node of global-af, vrf-global-afCommon node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

maximum-prefixes: object: Maximum number of prefixes to accept from this peer

Example

{
  "maximum-prefixes": {
    "discard-extra-paths": "boolean",
    "warning-percentage": "integer",
    "warning-only": "boolean",
    "prefix-limit": "integer",
    "restart-time": "integer"
  }
}

NEIGHBOR-GRACEFUL-RESTART-TIME:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

neighbor-graceful-restart-time: integer: Restart time advertised to neighbor
range:"1..4095" units:"second" default:"120"

Example

{
  "neighbor-graceful-restart-time": "integer"
}

BFD-ENABLE-MODES:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

bfd-enable-modes: string disable, default, strict: Strict mode, Default mode or Disable to prevent inheritance from a parent

Example

{
  "bfd-enable-modes": "string"
}

BEST-PATH-CONFEDERATION-PATHS:

Common node of global, vrf-global

best-path-confederation-paths: null: Change default route selection criteria and allow the comparing of MED among confederation paths

Example

{
  "best-path-confederation-paths": [ null ]
}

LOCAL-AS:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

local-as: object: Specify a local-as number

Example

{
  "local-as": {
    "replace-as": [ null ],
    "dual-as": [ null ],
    "no-prepend": [ null ],
    "as-xx": "string",
    "disable": [ null ],
    "as-yy": "string"
  }
}

ADDITIONAL-PATHS-SEND-CAPABILITY:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

additional-paths-send-capability: string enable, disable: Advertise additional paths Send capability

Example

{
  "additional-paths-send-capability": "string"
}

ADVERTISE-ORF:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-orf: string none, receive, send, both: Advertise ORF capability to the peer

Example

{
  "advertise-orf": "string"
}

L2VPN-SIGNALLING:

Common node of neighbor-group-af, neighbor-af, af-group-af

l2vpn-signalling: string bgp-disable, ldp-disable: Disable signalling type on the peer

Example

{
  "l2vpn-signalling": "string"
}

DEFAULT-ORIGINATE:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

default-originate: object: Originate default route to this neighbor

Example

{
  "default-originate": {
    "enable": "boolean",
    "route-policy-name": "string"
  }
}

EIGRP-ROUTE-TABLE:

Common node of global-af, vrf-global-af

eigrp-routes: object: Redistribute information for EIGRP routes.

Example

{
  "eigrp-routes": {
    "eigrp-route": [
      {
        "default-metric": "string",
        "route-policy-name": "string",
        "redist-type": "string",
        "instance-name": "string"
      }
    ]
  }
}

SITE-OF-ORIGIN:

Common node of neighbor-group-af, vrf-neighbor-af , af-group-af

site-of-origin: object: Site-of-Origin extended community associated with the neighbor

Example

{
  "site-of-origin": {
    "as-index": "string",
    "address-index": "string",
    "as-xx": "string",
    "as": "string",
    "address": "string",
    "type": "string"
  }
}

ALLOW-AS-IN:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

allow-as-in: integer: Allow as-path with my AS present in it
range:"1..10" default:"3"

Example

{
  "allow-as-in": "integer"
}

ADVERTISE-L2VPN-EVPN:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

advertise-l2vpn-evpn: object: Advertise Translated Routes to the peer

Example

{
  "advertise-l2vpn-evpn": {
    "af-name": "string",
    "rt-type": "string",
    "reorg-option": "string"
  }
}

AGGREGATE-ADDRESS-TABLE:

Common node of global-af, vrf-global-af

aggregate-addresses: object: Configure BGP aggregate entries

Example

{
  "aggregate-addresses": {
    "aggregate-address": [
      {
        "route-policy-name": "string",
        "aggregate-prefix": "integer",
        "summary-only": "boolean",
        "generate-set-info": "boolean",
        "generate-confederation-set-info": "boolean",
        "aggregate-addr": "string"
      }
    ]
  }
}

SOURCED-NETWORK-TABLE:

Common node of global-af, vrf-global-af

sourced-networks: object: Specify a network to announce via BGP

Example

{
  "sourced-networks": {
    "sourced-network": [
      {
        "network-prefix": "integer",
        "route-policy-name": "string",
        "network-addr": "string",
        "backdoor": "boolean"
      }
    ]
  }
}

BEST-EXTERNAL:

Common node of global-af, vrf-global-af

best-external: boolean: TRUE to enable BE FALSE to disable BE inheritance from a parent

Example

{
  "best-external": "boolean"
}

MOBILE-ROUTES:

Common node of global-af, vrf-global-af

mobile-routes: object: Redistribute mobile routes

Example

{
  "mobile-routes": {
    "default-metric": "string",
    "route-policy-name": "string",
    "not-used": "integer"
  }
}

PREFIX-ORF-POLICY:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-afCommon node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

prefix-orf-policy: string: Prefix ORF policy name for incoming updates

Example

{
  "prefix-orf-policy": "string"
}

BEST-PATH-AS-MULTIPATH-RELAX:

Common node of global, vrf-global

best-path-as-multipath-relax: null: Change default multi-route selection criteria to relax as-path checking - only require same aspath length

Example

{
  "best-path-as-multipath-relax": [ null ]
}

NEIGHBOR-CLUSTER-ID:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

neighbor-cluster-id: object: Neighbor Cluster-id

Example

{
  "neighbor-cluster-id": {
    "cluster-id-number": "integer",
    "cluster-id-address": "string"
  }
}

SESSION-OPEN-MODE:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

session-open-mode: string either, active-only, passive-only: TCP mode to be used to establish BGP session

Example

{
  "session-open-mode": "string"
}

SUPPRESS-ALL-CAPABILITIES:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

suppress-all-capabilities: boolean: TRUE to suppress all capabilities. FALSE to not suppress and to prevent inheritance from a parent

Example

{
  "suppress-all-capabilities": "boolean"
}

RESET-WEIGHT-ON-IMPORT:

Common node of global-af, vrf-global-af

reset-weight-on-import: boolean: TRUE to reset weight on import. FALSE to not reset and to prevent inheritance from a parent

Example

{
  "reset-weight-on-import": "boolean"
}

EBGP-MULTIHOP:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

ebgp-multihop: object: Allow EBGP neighbors not on directly connected networks

Example

{
  "ebgp-multihop": {
    "max-hop-count": "integer",
    "mpls-deactivation": "boolean"
  }
}

ENFORCE-FIRST-AS:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

enforce-first-as: boolean: TRUE to enforce first AS; FALSE to not enforce first AS.

Example

{
  "enforce-first-as": "boolean"
}

NEIGHBOR-AF-LONG-LIVED-GRACEFUL-RESTART-STALE-TIME:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

neighbor-af-long-lived-graceful-restart-stale-time: object: Maximum time to wait before purging long lived routes

Example

{
  "neighbor-af-long-lived-graceful-restart-stale-time": {
    "stale-time-send": "integer",
    "stale-time-accept": "integer"
  }
}

NEIGHBOR-GRACEFUL-RESTART:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

neighbor-graceful-restart: string true, false: TRUE to Enable graceful restart supportfor neighbor. FALSE to disable graceful restart support for neighbor.

Example

{
  "neighbor-graceful-restart": "string"
}

EGRESS-PEER-ENGINEERING:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

egress-peer-engineering: boolean: TRUE to enable egress peer engineering FALSE to disable egress peer engineering and to prevent inheritance from a parent

Example

{
  "egress-peer-engineering": "boolean"
}

PERMANENT-NETWORK:

Common node of global-af, vrf-global-af

permanent-network: string: Route policy for permanent networks

Example

{
  "permanent-network": "string"
}

DEFAULT-WEIGHT:

Common node of neighbor-group, neighbor, vrf-neighbor, session-groupCommon node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

default-weight: integer: Set default weight for routes from this neighbor/neighbor-group/af-group
range:"0..65535"

Example

{
  "default-weight": "integer"
}

ROUTE-REFLECTOR-CLIENT:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

route-reflector-client: boolean: TRUE to configure as a route-reflector-client. FALSE to prevent route-reflector-client from being inherited.

Example

{
  "route-reflector-client": "boolean"
}

APP-ROUTE-TABLE:

Common node of global-af, vrf-global-af

application-routes: object: Redistribute information for Application routes.

Example

{
  "application-routes": {
    "application-route": [
      {
        "default-metric": "string",
        "route-policy-name": "string",
        "instance-name": "string",
        "not-used": "integer"
      }
    ]
  }
}

SHUTDOWN:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

shutdown: boolean: TRUE to shutdown this entity, FALSE to prevent this entity from being shutdown even if the parent is.

Example

{
  "shutdown": "boolean"
}

ADDITIONAL-PATHS-SELECTION:

Common node of global-af, vrf-global-af

additional-paths-selection: object: Configure additional paths selection

Example

{
  "additional-paths-selection": {
    "selection": "string",
    "route-policy-name": "string"
  }
}

DISABLE-AUTO-SOFT-RESET:

Common node of global, vrf-global

disable-auto-soft-reset: null: Disable automatic soft peer reset on policy reconfiguration

Example

{
  "disable-auto-soft-reset": [ null ]
}

INTERNAL-VPN-CLIENT-IBGP-CE:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

internal-vpn-client-ibgp-ce: boolean: TRUE to preserve the CE path attributes.FALSE to override CE path attributes.

Example

{
  "internal-vpn-client-ibgp-ce": "boolean"
}

CONNECTED-ROUTES:

Common node of global-af, vrf-global-af

connected-routes: object: Redistribute connected routes

Example

{
  "connected-routes": {
    "default-metric": "string",
    "route-policy-name": "string",
    "not-used": "integer"
  }
}

ROUTER-ID:

Common node of global, vrf-global

router-id: string: Configure Router-id

Example

{
  "router-id": "string"
}

CREATE:

Common node of neighbor-group, session-group

create: null: Create this group. Deletion of this object causes deletion of all the objects under NeighborGroup/SessionGroup associated with this object.

Example

{
  "create": [ null ]
}

MSG-LOG-IN:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

msg-log-in: object: Message log inbound

Example

{
  "msg-log-in": {
    "msg-log-inherit-disable": "boolean",
    "msg-log-disable": "boolean",
    "msg-buf-count": "integer"
  }
}

REMOTE-AS-LIST:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

remote-as-list: string: Remote-as-list group name

Example

{
  "remote-as-list": "string"
}

TABLE-POLICY:

Common node of global-af, vrf-global-af

table-policy: string: Configure policy for installation of routes to RIB

Example

{
  "table-policy": "string"
}

BEST-PATH-MED-MISSING:

Common node of neighbor-group, neighbor, vrf-neighbor, session-groupCommon node of global, vrf-global

best-path-med-missing: null: Treat missing MED as the least preferred one

Example

{
  "best-path-med-missing": [ null ]
}

MULTIPATH:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

multipath: null: Allow paths from this neighbor to be eligible for selective multipath

Example

{
  "multipath": [ null ]
}

NEIGHBOR-GRACEFUL-RESTART-STALEPATH-TIME:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

neighbor-graceful-restart-stalepath-time: integer: Maximum time to wait for restart of GR capable peer
range:"1..4095" units:"second" default:"360"

Example

{
  "neighbor-graceful-restart-stalepath-time": "integer"
}

RECEIVE-SOCKET-BUFFER-SIZES:

Common node of global, vrf-globalCommon node of global, vrf-global

receive-socket-buffer-sizes: object: Set socket and BGP receive buffer sizes

Example

{
  "receive-socket-buffer-sizes": {
    "socket-receive-size": "integer",
    "bgp-receive-size": "integer"
  }
}

NEIGHBOR-GROUP-ADD-MEMBER:

Common node of neighbor, vrf-neighbor

neighbor-group-add-member: string: Inherit configuration from a neighbor-group

Example

{
  "neighbor-group-add-member": "string"
}

BFD-MINIMUM-INTERVAL:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

bfd-minimum-interval: integer: Hello interval for BFD sessions created by BGP
range:"3..30000" units:"millisecond"

Example

{
  "bfd-minimum-interval": "integer"
}

SEND-COMMUNITY-EBGP:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

send-community-ebgp: boolean: TRUE to send communities to the external neighbor/neighbor-group/af-group. FALSE not to send and to prevent inheritance from a parent

Example

{
  "send-community-ebgp": "boolean"
}

RIP-ROUTES:

Common node of global-af, vrf-global-af

rip-routes: object: Redistribute RIP routes

Example

{
  "rip-routes": {
    "default-metric": "string",
    "route-policy-name": "string",
    "not-used": "integer"
  }
}

UPDATE-IN-FILTERING:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

update-in-filtering: object: Inbound update filtering

Example

{
  "update-in-filtering": {
    "enable": [ null ],
    "update-in-filtering-message-buffers": {
      "number-of-buffers": "integer",
      "non-circular-buffer": "boolean"
    },
    "update-in-filtering-syslog-disable": [ null ],
    "update-in-filtering-attribute-filter-group": "string"
  }
}

ADDITIONAL-PATHS-RECEIVE-CAPABILITY:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

additional-paths-receive-capability: string enable, disable: Advertise additional paths Receive capability

Example

{
  "additional-paths-receive-capability": "string"
}

PASSWORD:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

password: object: Set or disable a password

Example

{
  "password": {
    "password-disable": "boolean",
    "password": "string"
  }
}

BEST-PATH-MED-ALWAYS:

Common node of global, vrf-global

best-path-med-always: null: Change default route selection criteria and allow comparing of MED from different neighbors

Example

{
  "best-path-med-always": [ null ]
}

TOS:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

tos: object: TOS (Type Of Service)

Example

{
  "tos": {
    "type": "string",
    "value": "string"
  }
}

ACCEPT-ROUTE-LEGACY-RT:

Common node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

accept-route-legacy-rt: boolean: TRUE to configure as a accept-route-legacy-RT. FALSE to prevent accept-route-legacy-RT from being inherited.

Example

{
  "accept-route-legacy-rt": "boolean"
}

OPTIMAL-ROUTE-REFLECTION-GROUP:

Common node of global-af, vrf-global-afCommon node of neighbor-group-af, neighbor-af, vrf-neighbor-af, af-group-af

optimal-route-reflection-group: string: Name of the ORR group this neighbor is going to be part of

Example

{
  "optimal-route-reflection-group": "string"
}

DESCRIPTION:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

description: string: Up to 80 characters describing this neighbor

Example

{
  "description": "string"
}

DISABLE-MSG-LOG:

Common node of global, vrf-global

disable-msg-log: null: Disable inbound and outbound messagelogging for all neighbors under the vrf

Example

{
  "disable-msg-log": [ null ]
}

BEST-PATH-AIGP-IGNORE:

Common node of global, vrf-global

best-path-aigp-ignore: null: Change default route selection criteria to ignore AIGP unless both paths whichare compared have AIGP attribute

Example

{
  "best-path-aigp-ignore": [ null ]
}

SESSION-GROUP-ADD-MEMBER:

Common node of neighbor-group, neighbor, vrf-neighbor

session-group-add-member: string: Inherit address-family independent config from a session-group

Example

{
  "session-group-add-member": "string"
}

IDLE-WATCH-TIME:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

idle-watch-time: integer: Time to wait for deleteing IDLE state Dynamic peer
range:"30..1800" units:"second"

Example

{
  "idle-watch-time": "integer"
}

RECEIVE-BUFFER-SIZE:

Common node of neighbor-group, neighbor, vrf-neighbor, session-group

receive-buffer-size: object: Set socket receive buffer size and BGP read buffer size

Example

{
  "receive-buffer-size": {
    "socket-receive-size": "integer",
    "bgp-receive-size": "integer"
  }
}

SEND-MULTICAST-ATTR:

Common node of neighbor-group-af, neighbor-af, af-group-af

send-multicast-attr: string enable, disable: Config send multicast attribute for this neighbor

Example

{
  "send-multicast-attr": "string"
}

bgp_schema:

bgp

instance: object[]: BGP instance configuration commands

Example

{
  "instance": [
    {
      "instance-as": [
        {
          "four-byte-as": [
            {
              "bgp-running": [ null ],
              "vrfs": {
                "vrf": [
                  {
                    "vrf-global": {
                      "route-distinguisher": {
                        "as-index": "string",
                        "address-index": "string",
                        "as-xx": "string",
                        "as": "string",
                        "address": "string",
                        "type": "string"
                      },
                      "exists": [ null ],
                      "vrf-global-afs": {
                        "vrf-global-af": [
                          {
                            "ibgp": {
                              "order-by-igp-metric": "boolean",
                              "paths-value": "integer",
                              "selective": "boolean",
                              "unequal-cost": "boolean"
                            },
                            "mvpn": {
                              "single-forwarder-selection": "string"
                            },
                            "rt-download": [ null ],
                            "af-name": "string",
                            "eibgp": {
                              "order-by-igp-metric": "boolean",
                              "paths-value": "integer",
                              "selective": "boolean",
                              "unequal-cost": "boolean"
                            },
                            "ebgp": {
                              "order-by-igp-metric": "boolean",
                              "paths-value": "integer",
                              "selective": "boolean",
                              "unequal-cost": "boolean"
                            },
                            "allow-vpn-default-originate": "boolean",
                            "subscriber-routes": {
                              "default-metric": "string",
                              "route-policy-name": "string",
                              "not-used": "integer"
                            }
                          }
                        ]
                      },
                      "local-preference": "integer"
                    },
                    "vrf-name": "string",
                    "vrf-neighbors": {
                      "vrf-neighbor-prefix-length": [
                        {
                          "neighbor-address": "string",
                          "prefix-length": "integer"
                        }
                      ],
                      "vrf-neighbor": [
                        {
                          "neighbor-address": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "as": "string",
              "default-vrf": {
                "global": {
                  "mvpn": [ null ],
                  "rpki-origin-as-validation-disable": [ null ],
                  "rpki-static-routes": {
                    "rpki-static-route": [
                      {
                        "addrress": "string",
                        "as": "integer",
                        "minimum": "integer",
                        "maximum": "integer"
                      }
                    ]
                  },
                  "update-error-handling-extended-ibgp": [ null ],
                  "install-diversion": [ null ],
                  "attribute-filter-groups": {
                    "attribute-filter-group": [
                      {
                        "enable": [ null ],
                        "attribute-filter-group-name": "string",
                        "attribute-filters": {
                          "attribute-filter": [
                            {
                              "attribute-start": "string",
                              "attribute-end": "string",
                              "filter-action": "string"
                            }
                          ]
                        }
                      }
                    ]
                  },
                  "update-limit-process": "integer",
                  "rpki-origin-as-validation-time": "integer",
                  "nsr": "boolean",
                  "read-only": [ null ],
                  "local-preference": "integer"
                }
              }
            }
          ]
        }
      ]
    }
  ]
}

instance_schema:

instance-as: object[]: Autonomous system
instance-name: string: Instance Name. For Default instance use - default

Example

{
  "instance-as": [
    {
      "four-byte-as": [
        {
          "bgp-running": [ null ],
          "vrfs": {
            "vrf": [
              {
                "vrf-global": {
                  "route-distinguisher": {
                    "as-index": "string",
                    "address-index": "string",
                    "as-xx": "string",
                    "as": "string",
                    "address": "string",
                    "type": "string"
                  },
                  "exists": [ null ],
                  "vrf-global-afs": {
                    "vrf-global-af": [
                      {
                        "ibgp": {
                          "order-by-igp-metric": "boolean",
                          "paths-value": "integer",
                          "selective": "boolean",
                          "unequal-cost": "boolean"
                        },
                        "mvpn": {
                          "single-forwarder-selection": "string"
                        },
                        "rt-download": [ null ],
                        "af-name": "string",
                        "eibgp": {
                          "order-by-igp-metric": "boolean",
                          "paths-value": "integer",
                          "selective": "boolean",
                          "unequal-cost": "boolean"
                        },
                        "ebgp": {
                          "order-by-igp-metric": "boolean",
                          "paths-value": "integer",
                          "selective": "boolean",
                          "unequal-cost": "boolean"
                        },
                        "allow-vpn-default-originate": "boolean",
                        "subscriber-routes": {
                          "default-metric": "string",
                          "route-policy-name": "string",
                          "not-used": "integer"
                        }
                      }
                    ]
                  },
                  "local-preference": "integer"
                },
                "vrf-name": "string",
                "vrf-neighbors": {
                  "vrf-neighbor-prefix-length": [
                    {
                      "neighbor-address": "string",
                      "prefix-length": "integer"
                    }
                  ],
                  "vrf-neighbor": [
                    {
                      "neighbor-address": "string"
                    }
                  ]
                }
              }
            ]
          },
          "as": "string",
          "default-vrf": {
            "global": {
              "mvpn": [ null ],
              "rpki-origin-as-validation-disable": [ null ],
              "rpki-static-routes": {
                "rpki-static-route": [
                  {
                    "addrress": "string",
                    "as": "integer",
                    "minimum": "integer",
                    "maximum": "integer"
                  }
                ]
              },
              "update-error-handling-extended-ibgp": [ null ],
              "install-diversion": [ null ],
              "attribute-filter-groups": {
                "attribute-filter-group": [
                  {
                    "enable": [ null ],
                    "attribute-filter-group-name": "string",
                    "attribute-filters": {
                      "attribute-filter": [
                        {
                          "attribute-start": "string",
                          "attribute-end": "string",
                          "filter-action": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "update-limit-process": "integer",
              "rpki-origin-as-validation-time": "integer",
              "nsr": "boolean",
              "read-only": [ null ],
              "graceful-restart-stalepath-time": "integer",
              "graceful-reset": [ null ],
              "local-preference": "integer"
            }
          }
        }
      ]
    }
  ]
}

instance-as_schema:

four-byte-as: object[]: 4-byte Autonomous system
as: string: Higher 16 bits of 4-byte Autonomous system number

Example

{
  "four-byte-as": [
    {
      "bgp-running": [ null ],
      "vrfs": {
        "vrf": [
          {
            "vrf-global": {
              "route-distinguisher": {
                "as-index": "string",
                "address-index": "string",
                "as-xx": "string",
                "as": "string",
                "address": "string",
                "type": "string"
              },
              "exists": [ null ],
              "vrf-global-afs": {
                "vrf-global-af": [
                  {
                    "ibgp": {
                      "order-by-igp-metric": "boolean",
                      "paths-value": "integer",
                      "selective": "boolean",
                      "unequal-cost": "boolean"
                    },
                    "mvpn": {
                      "single-forwarder-selection": "string"
                    },
                    "rt-download": [ null ],
                    "af-name": "string",
                    "eibgp": {
                      "order-by-igp-metric": "boolean",
                      "paths-value": "integer",
                      "selective": "boolean",
                      "unequal-cost": "boolean"
                    },
                    "ebgp": {
                      "order-by-igp-metric": "boolean",
                      "paths-value": "integer",
                      "selective": "boolean",
                      "unequal-cost": "boolean"
                    },
                    "allow-vpn-default-originate": "boolean",
                    "subscriber-routes": {
                      "default-metric": "string",
                      "route-policy-name": "string",
                      "not-used": "integer"
                    }
                  }
                ]
              },
              "local-preference": "integer"
            },
            "vrf-name": "string",
            "vrf-neighbors": {
              "vrf-neighbor-prefix-length": [
                {
                  "neighbor-address": "string",
                  "prefix-length": "integer"
                }
              ],
              "vrf-neighbor": [
                {
                  "neighbor-address": "string"
                }
              ]
            }
          }
        ]
      },
      "as": "string",
      "default-vrf": {
        "global": {
          "mvpn": [ null ],
          "rpki-origin-as-validation-disable": [ null ],
          "rpki-static-routes": {
            "rpki-static-route": [
              {
                "addrress": "string",
                "as": "integer",
                "minimum": "integer",
                "maximum": "integer"
              }
            ]
          },
          "update-error-handling-extended-ibgp": [ null ],
          "install-diversion": [ null ],
          "attribute-filter-groups": {
            "attribute-filter-group": [
              {
                "enable": [ null ],
                "attribute-filter-group-name": "string",
                "attribute-filters": {
                  "attribute-filter": [
                    {
                      "attribute-start": "string",
                      "attribute-end": "string",
                      "filter-action": "string"
                    }
                  ]
                }
              }
            ]
          },
          "update-limit-process": "integer",
          "rpki-origin-as-validation-time": "integer",
          "nsr": "boolean",
          "read-only": [ null ],
          "graceful-restart-stalepath-time": "integer",
          "graceful-reset": [ null ],
          "update-out-logging": [ null ],
          "graceful-restart-time": "integer",
          "local-preference": "integer"
        }
      }
    }
  ]
}

four-byte-as_schema:

bgp-running: null: Enable BGP. Deletion of this object causes deletion of all the objects under FourByteAS associated with this object.
our-byte-as_as: string: 2-byte or 4-byte Autonomous system number
vrfs: object: VRF config
default-vrf: object: Global default config

Example

{
  "bgp-running": [ null ],
  "our-byte-as_as": "string",
  "vrfs": {
    "vrf": [
      {
        "vrf-global": {
          "route-distinguisher": {
            "as-index": "string",
            "address-index": "string",
            "as-xx": "string",
            "as": "string",
            "address": "string",
            "type": "string"
          },
          "exists": [ null ],
          "vrf-global-afs": {
            "vrf-global-af": [
              {
                "ibgp": {
                  "order-by-igp-metric": "boolean",
                  "paths-value": "integer",
                  "selective": "boolean",
                  "unequal-cost": "boolean"
                },
                "mvpn": {
                  "single-forwarder-selection": "string"
                },
                "rt-download": [ null ],
                "af-name": "string",
                "eibgp": {
                  "order-by-igp-metric": "boolean",
                  "paths-value": "integer",
                  "selective": "boolean",
                  "unequal-cost": "boolean"
                },
                "ebgp": {
                  "order-by-igp-metric": "boolean",
                  "paths-value": "integer",
                  "selective": "boolean",
                  "unequal-cost": "boolean"
                },
                "allow-vpn-default-originate": "boolean",
                "subscriber-routes": {
                  "default-metric": "string",
                  "route-policy-name": "string",
                  "not-used": "integer"
                }
              }
            ]
          },
          "local-preference": "integer"
        },
        "vrf-name": "string",
        "vrf-neighbors": {
          "vrf-neighbor-prefix-length": [
            {
              "neighbor-address": "string",
              "prefix-length": "integer"
            }
          ],
          "vrf-neighbor": [
            {
              "neighbor-address": "string"
            }
          ]
        }
      }
    ]
  },
  "default-vrf": {
    "global": {
      "mvpn": [ null ],
      "rpki-origin-as-validation-disable": [ null ],
      "rpki-static-routes": {
        "rpki-static-route": [
          {
            "addrress": "string",
            "as": "integer",
            "minimum": "integer",
            "maximum": "integer"
          }
        ]
      },
      "update-error-handling-extended-ibgp": [ null ],
      "install-diversion": [ null ],
      "attribute-filter-groups": {
        "attribute-filter-group": [
          {
            "enable": [ null ],
            "attribute-filter-group-name": "string",
            "attribute-filters": {
              "attribute-filter": [
                {
                  "attribute-start": "string",
                  "attribute-end": "string",
                  "filter-action": "string"
                }
              ]
            }
          }
        ]
      },
      "update-limit-process": "integer",
      "rpki-origin-as-validation-time": "integer",
      "nsr": "boolean",
      "read-only": [ null ],
      "graceful-restart-stalepath-time": "integer",
      "graceful-reset": [ null ],
      "update-out-logging": [ null ],
      "graceful-restart-time": "integer",
      "confederation-domain": {
        "as-xx": "string"
      },
      "local-preference": "integer"
    }
  }
}

vrfs_schema:

VRF config

vrf: object[]: VRF config

Example

{
  "vrf": [
    {
      "vrf-global": {
        "route-distinguisher": {
          "as-index": "string",
          "address-index": "string",
          "as-xx": "string",
          "as": "string",
          "address": "string",
          "type": "string"
        },
        "exists": [ null ],
        "vrf-global-afs": {
          "vrf-global-af": [
            {
              "ibgp": {
                "order-by-igp-metric": "boolean",
                "paths-value": "integer",
                "selective": "boolean",
                "unequal-cost": "boolean"
              },
              "mvpn": {
                "single-forwarder-selection": "string"
              },
              "rt-download": [ null ],
              "af-name": "string",
              "eibgp": {
                "order-by-igp-metric": "boolean",
                "paths-value": "integer",
                "selective": "boolean",
                "unequal-cost": "boolean"
              },
              "ebgp": {
                "order-by-igp-metric": "boolean",
                "paths-value": "integer",
                "selective": "boolean",
                "unequal-cost": "boolean"
              },
              "allow-vpn-default-originate": "boolean",
              "subscriber-routes": {
                "default-metric": "string",
                "route-policy-name": "string",
                "not-used": "integer"
              }
            }
          ]
        },
        "local-preference": "integer"
      },
      "vrf-name": "string",
      "vrf-neighbors": {
        "vrf-neighbor-prefix-length": [
          {
            "neighbor-address": "string",
            "prefix-length": "integer"
          }
        ],
        "vrf-neighbor": [
          {
            "neighbor-address": "string"
          }
        ]
      }
    }
  ]
}

vrf_schema:

vrf-global:: VRF attribute config
vrf-name: string: VRF name
vrf-neighbors: object: BGP VRF peer

Example

{
  "vrf-global": {
    "route-distinguisher": {
      "as-index": "string",
      "address-index": "string",
      "as-xx": "string",
      "as": "string",
      "address": "string",
      "type": "string"
    },
    "exists": [ null ],
    "vrf-global-afs": {
      "vrf-global-af": [
        {
          "ibgp": {
            "order-by-igp-metric": "boolean",
            "paths-value": "integer",
            "selective": "boolean",
            "unequal-cost": "boolean"
          },
          "mvpn": {
            "single-forwarder-selection": "string"
          },
          "rt-download": [ null ],
          "af-name": "string",
          "eibgp": {
            "order-by-igp-metric": "boolean",
            "paths-value": "integer",
            "selective": "boolean",
            "unequal-cost": "boolean"
          },
          "ebgp": {
            "order-by-igp-metric": "boolean",
            "paths-value": "integer",
            "selective": "boolean",
            "unequal-cost": "boolean"
          },
          "allow-vpn-default-originate": "boolean",
          "subscriber-routes": {
            "default-metric": "string",
            "route-policy-name": "string",
            "not-used": "integer"
          }
        }
      ]
    },
    "local-preference": "integer"
  },
  "vrf-name": "string",
  "vrf-neighbors": {
    "vrf-neighbor-prefix-length": [
      {
        "neighbor-address": "string",
        "prefix-length": "integer"
      }
    ],
    "vrf-neighbor": [
      {
        "neighbor-address": "string"
      }
    ]
  }
}

vrf-global_schema:

VRF attribute config

LOCAL-PREFERENCE

route-distinguisher: object: Route distinguisher
exists: null: Create this VRF. Deletion of this object causes deletion of all the objects under VRF associated with this object.
vrf-global-afs: object: Global VRF-specific configuration

Example

{
  "route-distinguisher": {
    "as-index": "string",
    "address-index": "string",
    "as-xx": "string",
    "as": "string",
    "address": "string",
    "type": "string"
  },
  "exists": [ null ],
  "vrf-global-afs": {
    "vrf-global-af": [
      {
        "ibgp": {
          "order-by-igp-metric": "boolean",
          "paths-value": "integer",
          "selective": "boolean",
          "unequal-cost": "boolean"
        },
        "mvpn": {
          "single-forwarder-selection": "string"
        },
        "rt-download": [ null ],
        "af-name": "string",
        "eibgp": {
          "order-by-igp-metric": "boolean",
          "paths-value": "integer",
          "selective": "boolean",
          "unequal-cost": "boolean"
        },
        "ebgp": {
          "order-by-igp-metric": "boolean",
          "paths-value": "integer",
          "selective": "boolean",
          "unequal-cost": "boolean"
        },
        "allow-vpn-default-originate": "boolean",
        "subscriber-routes": {
          "default-metric": "string",
          "route-policy-name": "string",
          "not-used": "integer"
        }
      }
    ]
  },
  "local-preference": "integer"
}

route-distinguisher_schema:

Route distinguisher

as-index: string: ASN Index
address-index: string: IP address index
as-xx: string: AS number
as: string: AS number
address: string: IP address
type: string auto, as, four-byte-as, ipv4-address: Type of RD

Example

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

vrf-global-afs_schema:

Global VRF-specific configuration

vrf-global-af: object[]: Global VRF AF-specific configuration

Example

{
  "vrf-global-af": [
    {
      "ibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "mvpn": {
        "single-forwarder-selection": "string"
      },
      "rt-download": [ null ],
      "af-name": "string",
      "eibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "ebgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "allow-vpn-default-originate": "boolean",
      "subscriber-routes": {
        "default-metric": "string",
        "route-policy-name": "string",
        "not-used": "integer"
      }
    }
  ]
}

vrf-global-af_schema:

SUBSCRIBER-ROUTES

ibgp: object: Use iBGP multipaths
mvpn: object: MVPN configurations
rt-download: null: Route-Target download configuration
af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: Address family
eibgp: object: Use eiBGP multipaths
ebgp: object: Use eBGP multipaths
allow-vpn-default-originate: boolean: TRUE to send default orig route to VPN neighborFALSE to not send default originate route

Example

{
  "ibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "mvpn": {
    "single-forwarder-selection": "string"
  },
  "rt-download": [ null ],
  "af-name": "string",
  "eibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "ebgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "allow-vpn-default-originate": "boolean",
  "subscriber-routes": {
    "default-metric": "string",
    "route-policy-name": "string",
    "not-used": "integer"
  }
}

mvpn_schema:

MVPN configurations

single-forwarder-selection: string all-paths, highest-ip-address: Select MVPN single forwarder selection

Example

{
  "single-forwarder-selection": "string"
}

ebgp_schema:

Use eBGP multipaths

order-by-igp-metric: boolean: Order candidate multipaths by IGP metric
paths-value: integer: Number of paths
range:"2..64"
selective: boolean: Allow multipaths only from marked neighbors
unequal-cost: boolean: UNUSED

Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

eibgp_schema:

Use eiBGP multipaths

order-by-igp-metric: boolean: Order candidate multipaths by IGP metric
paths-value: integer: Number of paths
range:"2..64"
selective: boolean: Allow multipaths only from marked neighbors
unequal-cost: boolean: UNUSED

Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

ibgp_schema:

Use iBGP multipaths

order-by-igp-metric: boolean: Order candidate multipaths by IGP metric
paths-value: integer: Number of paths
range:"2..64"
selective: boolean: Allow multipaths only from marked neighbors
unequal-cost: boolean: Allow multipaths to have different IGP metrics

Example

{
  "order-by-igp-metric": "boolean",
  "paths-value": "integer",
  "selective": "boolean",
  "unequal-cost": "boolean"
}

aggregate-addresses_schema:

Configure BGP aggregate entries

aggregate-address: object[]: Aggregate address configuration

Example

{
  "aggregate-address": [
    {
      "route-policy-name": "string",
      "aggregate-prefix": "integer",
      "summary-only": "boolean",
      "generate-set-info": "boolean",
      "generate-confederation-set-info": "boolean",
      "aggregate-addr": "string"
    }
  ]
}

aggregate-address_schema:

route-policy-name: string: Route policy on which to condition advertisement, suppression, and attributes
aggregate-prefix: integer: Aggregate in prefix/length format (prefix part)
range:"0..128"
summary-only: boolean: TRUE to filter more specific routes from updates, FALSEotherwise
generate-set-info: boolean: TRUE to generate AS set path information, FALSE otherwise
generate-confederation-set-info: boolean: TRUE to generate AS confederation set path information, FALSE otherwise
aggregate-addr: string: Aggregate in prefix/length format (address part)

Example

{
  "route-policy-name": "string",
  "aggregate-prefix": "integer",
  "summary-only": "boolean",
  "generate-set-info": "boolean",
  "generate-confederation-set-info": "boolean",
  "aggregate-addr": "string"
}

optimal-route-reflector-groups_schema:

Table of multiple ORR groups

optimal-route-reflector-group: object[]: Optimal Route Reffelctor group. Each such group is equivalent to an IGP area

Example

{
  "optimal-route-reflector-group": [
    {
      "primary-root-address": "string",
      "group-name": "string",
      "tertiary-root-address": "string",
      "secondary-root-address": "string"
    }
  ]
}

optimal-route-reflector-group_schema:

primary-root-address: string: Primary Root for the ORR group
group-name: string: Name of the ORR group
tertiary-root-address: string: Tertiary Root for the ORR group
secondary-root-address: string: Secondary Root for the ORR group

Example

{
  "primary-root-address": "string",
  "group-name": "string",
  "tertiary-root-address": "string",
  "secondary-root-address": "string"
}

dampening_schema:

Enable route-flap dampening

reuse-threshold: integer: Value to start reusing a route.
range:"1..20000"
half-life: integer: Half-life time for the penalty (minutes).
range:"1..45" units:"minute"
suppress-time: integer: Maximum duration to suppress a stable route (seconds).
range:"1..255" units:"second"
suppress-threshold: integer: Value to start suppressing a route.
range:"1..20000"
route-policy-name: string: Route policy to specify criteria for dampening. This cannot be specified if any other parameters are specified.

Example

{
  "reuse-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "suppress-threshold": "integer",
  "route-policy-name": "string"
}

rip-routes_schema:

Redistribute RIP routes

default-metric: string: Default metric
route-policy-name: string: Route policy name
not-used: integer: Not used
range:"0..127"

Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

lisp-routes_schema:

Redistribute lisp routes

default-metric: string: Default metric
route-policy-name: string: Route policy name

Example

{
  "default-metric": "string",
  "route-policy-name": "string"
}

static-routes_schema:

Redistribute static routes

default-metric: string: Default metric
route-policy-name: string: Route policy name
not-used: integer: Not used
range:"0..127"

Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

distance_schema:

Define an administrative distance

external-routes: integer: Distance for routes external to the AS
range:"1..255" default:"20"
local-routes: integer: Distance for local routes
range:"1..255" default:"200"
internal-routes: integer: Distance for routes internal to the AS
range:"1..255" default:"200"

Example

{
  "external-routes": "integer",
  "local-routes": "integer",
  "internal-routes": "integer"
}

application-routes_schema:

Redistribute information for Application routes.

application-route: object[]: Redistribute application routes

Example

{
  "application-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "instance-name": "string",
      "not-used": "integer"
    }
  ]
}

application-route_schema:

default-metric: string: Default metric
route-policy-name: string: Route policy name
instance-name: string: OnePK application name
not-used: integer: Not used
range:"0..127"

Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "instance-name": "string",
  "not-used": "integer"
}

label-mode_schema:

BGP 6PE/MPLS-VPN label allocation mode

route-policy-name: string: Label mode route policy name
label-allocation-mode: string: Label allocation mode: per-ce Set per CE label mode, per-vrf Set per VRF label mode, per-prefix Set per Prefix label mode (for MPLS-VPN only)

Example

{
  "route-policy-name": "string",
  "label-allocation-mode": "string"
}

eigrp-routes_schema:

Redistribute information for EIGRP routes.

eigrp-route: object[]: Redistribute EIGRP routes

Example

{
  "eigrp-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

eigrp-route_schema:

default-metric: string: Default metric
route-policy-name: string: Route policy name
redist-type: string: Redistribution type: 01 for internal routes, 02 for external routes, Logical combinations permitted.
instance-name: string: EIGRP router tag

Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

sourced-networks_schema:

Specify a network to announce via BGP

sourced-network: object[]: Sourced network configuration

Example

{
  "sourced-network": [
    {
      "network-prefix": "integer",
      "route-policy-name": "string",
      "network-addr": "string",
      "backdoor": "boolean"
    }
  ]
}

sourced-network_schema:

network-prefix: integer: Network in prefix/length format (prefix part)
range:"0..128"
route-policy-name: string: Route policy name
network-addr: string: Network in prefix/length format (address part)
backdoor: boolean: Specify a BGP backdoor route, default is FALSE

Example

{
  "network-prefix": "integer",
  "route-policy-name": "string",
  "network-addr": "string",
  "backdoor": "boolean"
}

connected-routes_schema:

Redistribute connected routes

default-metric: string: Default metric
route-policy-name: string: Route policy name
not-used: integer: Not used
range:"0..127"

Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

allocate-label_schema:

Label allocation policy

all: boolean: Whether all nets should be labeled, default is FALSE
route-policy-name: string: Route policy name
un-labeled-path: boolean: Allocate label for unlabeled paths too

Example

{
  "all": "boolean",
  "route-policy-name": "string",
  "un-labeled-path": "boolean"
}

additional-paths-selection_schema:

Configure additional paths selection

selection: string enable, disable: Enable/disable selection
route-policy-name: string: Route policy for selection

Example

{
  "selection": "string",
  "route-policy-name": "string"
}

ospf-routes_schema:

Redistribute information for OSPF routes.

ospf-route: object[]: Redistribute OSPF routes

Example

{
  "ospf-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

ospf-route_schema:

default-metric: string: Default metric
route-policy-name: string: Route policy name
redist-type: string: Redistribution type: 01 for internal routes, 02 for external routes of type 1, 04 for external routes of type 2, 08 for NSSA external routes of type 1, 10 for NSSA external routes of type 2, 20 for external routes, 40 for NSSA external routes. Logical combinations permitted.
instance-name: string: OSPF router tag

Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

mobile-routes_schema:

Redistribute mobile routes

default-metric: string: Default metric
route-policy-name: string: Route policy name
not-used: integer: Not used
range:"0..127"

Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

subscriber-routes_schema:

Redistribute subscriber routes

default-metric: string: Default metric
route-policy-name: string: Route policy name
not-used: integer: Not used
range:"0..127"

Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "not-used": "integer"
}

mpls-activated-interfaces_schema:

Configure list of MPLS activated interfaces

mpls-activated-interface: object[]: Configure a MPLS activated interface

Example

{
  "mpls-activated-interface": [
    {
      "interface-name": "string"
    }
  ]
}

mpls-activated-interface_schema:

interface-name: string: Interface Name

Example

{
  "interface-name": "string"
}

global-timers_schema:

Adjust routing timers.

min-accept-hold-time: integer: Minimum acceptable hold time (seconds). Specify 0 to disable keepalives/hold time
range:"0..65535" units:"second" default:"3"
hold-time: integer: Hold time (seconds). Specify 0 to disable keepalives/hold time
range:"0..65535" units:"second" default:"180"
keepalive: integer: Keepalive interval (seconds)
range:"0..65535" units:"second" default:"60"

Example

{
  "min-accept-hold-time": "integer",
  "hold-time": "integer",
  "keepalive": "integer"
}

bfd_schema:

BFD configuration

detection-multiplier: integer: Detection multiplier for BFD sessions created by BGP
range:"2..16"
interval: integer: Hello interval for BFD sessions created by BGP
range:"3..30000" units:"millisecond"

Example

{
  "detection-multiplier": "integer",
  "interval": "integer"
}

send-socket-buffer-sizes_schema:

set socket parameters

bgp-send-size: integer: BGP Write buffer size in bytes
range:"4096..131072" units:"byte" default:"4096"
socket-send-size: integer: Send socket buffer size in bytes
range:"4096..131072" units:"byte" default:"24576"

Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

receive-socket-buffer-sizes_schema:

Set socket and BGP receive buffer sizes

socket-receive-size: integer: Receive socket buffer size in bytes
range:"512..131072" units:"byte" default:"32768"
bgp-receive-size: integer: BGP Read buffer size in bytes
range:"512..131072" units:"byte" default:"4096"

Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

vrf-neighbors_schema:

BGP VRF peer

vrf-neighbor-prefix-length: object[]: A particular VRF peer
vrf-neighbor: object[]: A particular VRF peer

Example

{
  "vrf-neighbor-prefix-length": [
    {
      "neighbor-address": "string",
      "prefix-length": "integer"
    }
  ],
  "vrf-neighbor": [
    {
      "neighbor-address": "string"
    }
  ]
}

vrf-neighbor_schema:

VRF-NEIGHBOR-CONTENT

neighbor-address: string: Neighbor address

Example

{
  "neighbor-address": "string"
}

vrf-neighbor-afs_schema:

Address family type of a VRF neighbor

vrf-neighbor-af: ADVERTISE-VRF-IMP-DISABLE-V4: Address family type of a VRF neighbor

Example

{
  "vrf-neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

aigp-cost-community_schema:

Send AIGP value in Cost Community.

enable: boolean: TRUE to enable sending cost community, FALSE otherwise
cost-community-poi-type: string pre-best-path, igp-cost: Cost Community POI
cost-community-id: integer: Cost Community ID
range:"0..255"
transitive: boolean: True to send transitive cost community FALSE otherwise

Example

{
  "enable": "boolean",
  "cost-community-poi-type": "string",
  "cost-community-id": "integer",
  "transitive": "boolean"
}

advertise-def-imp-disable-v6_schema:

Disable Advertise Of Default VRF Imported Routes

af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: Address family
rt-type: string bgp-regular-rt, bgp-stitching-rt: RT type
adv-option: string bgp-cfg-adv, bgp-cfg-adv-reorg, bgp-cfg-adv-disable, bgp-cfg-adv-local, bgp-cfg-adv-def-vrf-imp-disable, bgp-cfg-adv-vrf-re-imp-disable: Advertise option

Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

advertise-disable_schema:

Disable Advertise Of Routes to the peer

af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: Address family
rt-type: string bgp-regular-rt, bgp-stitching-rt: RT type
reorg-option: string bgp-cfg-adv, bgp-cfg-adv-reorg, bgp-cfg-adv-disable, bgp-cfg-adv-local, bgp-cfg-adv-def-vrf-imp-disable, bgp-cfg-adv-vrf-re-imp-disable: Reorigination option

Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

maximum-prefixes_schema:

Maximum number of prefixes to accept from this peer

discard-extra-paths: boolean: Discard extra paths when limit is exceeded
warning-percentage: integer: Threshold value (%) at which to generate a warning message.
range:"1..100" default:"75"
warning-only: boolean: TRUE to only give a warning message when limit is exceeded. FALSE to accept max prefix limit only.
prefix-limit: integer: Maximum prefixes limit
range:"1..4294967295"
restart-time: integer: Restart interval
range:"0..65535" default:"0"

Example

{
  "discard-extra-paths": "boolean",
  "warning-percentage": "integer",
  "warning-only": "boolean",
  "prefix-limit": "integer",
  "restart-time": "integer"
}

remove-private-as-entire-as-path-inbound_schema:

Remove private AS number from inbound updates

entire: boolean: TRUE to remove private AS from inbound updates if all ASes in aspath areprivate. FALSE to prevent remove-private-ASfrom being inherited.
enable: boolean: TRUE to remove private AS from inbound updates. FALSE to prevent remove-private-AS from being inherited.

Example

{
  "entire": "boolean",
  "enable": "boolean"
}

advertise-def-imp-disable-v4_schema:

Disable Advertise Of Default VRF Imported Routes

af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: Address family
rt-type: string bgp-regular-rt, bgp-stitching-rt: RT type
adv-option: string bgp-cfg-adv, bgp-cfg-adv-reorg, bgp-cfg-adv-disable, bgp-cfg-adv-local, bgp-cfg-adv-def-vrf-imp-disable, bgp-cfg-adv-vrf-re-imp-disable: Advertise option

Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

advertise-l2vpn-evpn_schema:

Advertise Translated Routes to the peer

af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: Address family
rt-type: string bgp-regular-rt, bgp-stitching-rt: RT type
reorg-option: string bgp-cfg-adv, bgp-cfg-adv-reorg, bgp-cfg-adv-disable, bgp-cfg-adv-local, bgp-cfg-adv-def-vrf-imp-disable, bgp-cfg-adv-vrf-re-imp-disable: Reorigination option

Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

advertise-local-l2vpn-evpn_schema:

Advertise Of Local Routes to the peer with different RT

af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: Address family
rt-type: string bgp-regular-rt, bgp-stitching-rt: RT type
reorg-option: string bgp-cfg-adv, bgp-cfg-adv-reorg, bgp-cfg-adv-disable, bgp-cfg-adv-local, bgp-cfg-adv-def-vrf-imp-disable, bgp-cfg-adv-vrf-re-imp-disable: Reorigination option

Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

neighbor-af-long-lived-graceful-restart-stale-time_schema:

Maximum time to wait before purging long lived routes

stale-time-send: integer: Max time (seconds)
range:"0..16777215" units:"second" default:"0"
stale-time-accept: integer: Max time (seconds)
range:"0..16777215" units:"second" default:"0"

Example

{
  "stale-time-send": "integer",
  "stale-time-accept": "integer"
}

site-of-origin_schema:

Site-of-Origin extended community associated with the neighbor

as-index: string: AS number Index
address-index: string: IP address Index
as-xx: string: AS number
as: string: AS number
address: string: IP address
type: string as, ipv4-address, four-byte-as: Type of Extended community

Example

{
  "as-index": "string",
  "address-index": "string",
  "as-xx": "string",
  "as": "string",
  "address": "string",
  "type": "string"
}

advertise-v6_schema:

Advertise Translated Routes to the peer

af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: Address family
rt-type: string bgp-regular-rt, bgp-stitching-rt: RT type
reorg-option: string bgp-cfg-adv, bgp-cfg-adv-reorg, bgp-cfg-adv-disable, bgp-cfg-adv-local, bgp-cfg-adv-def-vrf-imp-disable, bgp-cfg-adv-vrf-re-imp-disable: Reorigination option

Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

advertise-local-v6_schema:

Advertise Of Local Routes to the peer with different RT

af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: Address family
rt-type: string bgp-regular-rt, bgp-stitching-rt: RT type
reorg-option: string bgp-cfg-adv, bgp-cfg-adv-reorg, bgp-cfg-adv-disable, bgp-cfg-adv-local, bgp-cfg-adv-def-vrf-imp-disable, bgp-cfg-adv-vrf-re-imp-disable: Reorigination option

Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

import_schema:

Import Reorigination options for Routes from the peer

import-reoriginate: boolean: TRUE to Reoriginate imported routes, FALSE to not Reoriginate imported routes - not supported
import-stitching: boolean: TRUE to Import with Stitching RTs, FALSE to Import with normal RTs
import-reoriginate-stitching: boolean: TRUE to Reoriginate imported routes with Stitching RTs, FALSE to Reoriginate imported routes with normal RTs

Example

{
  "import-reoriginate": "boolean",
  "import-stitching": "boolean",
  "import-reoriginate-stitching": "boolean"
}

default-originate_schema:

Originate default route to this neighbor

enable: boolean: FALSE to prevent default-originate from, being inherited from a parent. TRUE otherwise.
route-policy-name: string: Route policy name to specify criteria to originate default.

Example

{
  "enable": "boolean",
  "route-policy-name": "string"
}

soft-reconfiguration_schema:

Enable/disable inbound soft reconfiguration for this neighbor/neighbor-group/af-group

soft-always: boolean: TRUE to always use soft reconfig, even if route refresh is supported. FALSE otherwise.
inbound-soft: boolean: FALSE to prohibit inbound soft reconfiguration. TRUE otherwise.

Example

{
  "soft-always": "boolean",
  "inbound-soft": "boolean"
}

advertise-vrf-imp-disable-v6_schema:

Disable Advertise Of VRF ReImported Routes

af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: Address family
rt-type: string bgp-regular-rt, bgp-stitching-rt: RT type
adv-option: string bgp-cfg-adv, bgp-cfg-adv-reorg, bgp-cfg-adv-disable, bgp-cfg-adv-local, bgp-cfg-adv-def-vrf-imp-disable, bgp-cfg-adv-vrf-re-imp-disable: Advertise option

Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

advertise-v4_schema:

Advertise Translated Routes to the peer

af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: Address family
rt-type: string bgp-regular-rt, bgp-stitching-rt: RT type
reorg-option: string bgp-cfg-adv, bgp-cfg-adv-reorg, bgp-cfg-adv-disable, bgp-cfg-adv-local, bgp-cfg-adv-def-vrf-imp-disable, bgp-cfg-adv-vrf-re-imp-disable: Reorigination option

Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

advertise-local-v4_schema:

Advertise Of Local Routes to the peer with different RT

af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: Address family
rt-type: string bgp-regular-rt, bgp-stitching-rt: RT type
reorg-option: string bgp-cfg-adv, bgp-cfg-adv-reorg, bgp-cfg-adv-disable, bgp-cfg-adv-local, bgp-cfg-adv-def-vrf-imp-disable, bgp-cfg-adv-vrf-re-imp-disable: Reorigination option

Example

{
  "af-name": "string",
  "rt-type": "string",
  "reorg-option": "string"
}

remove-private-as-entire-as-path_schema:

Remove private AS number from outbound updates

entire: boolean: TRUE to remove private AS from outbound updates if all ASes in aspath areprivate. FALSE to prevent remove-private-ASfrom being inherited.
enable: boolean: TRUE to remove private AS from outbound updates . FALSE to prevent remove-private-AS from being inherited.

Example

{
  "entire": "boolean",
  "enable": "boolean"
}

advertise-vrf-imp-disable-v4_schema:

Disable Advertise Of VRF ReImported Routes

af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: Address family
rt-type: string bgp-regular-rt, bgp-stitching-rt: RT type
adv-option: string bgp-cfg-adv, bgp-cfg-adv-reorg, bgp-cfg-adv-disable, bgp-cfg-adv-local, bgp-cfg-adv-def-vrf-imp-disable, bgp-cfg-adv-vrf-re-imp-disable: Advertise option

Example

{
  "af-name": "string",
  "rt-type": "string",
  "adv-option": "string"
}

local-address_schema:

Local ip address

local-address-disable: boolean: TRUE to prevent this entity from having a local address if the parent has one.FALSE to specify local ip address
local-ip-address: string: Local ip address for neighbor

Example

{
  "local-address-disable": "boolean",
  "local-ip-address": "string"
}

bmp-activates_schema:

Enable BMP logging for this neighbor

bmp-activate: object[]: Enable BMP logging for this particular server

Example

{
  "bmp-activate": [
    {
      "server-id": "integer"
    }
  ]
}

bmp-activate_schema:

server-id: integer: BMP Server ID
range:"1..8"

Example

{
  "server-id": "integer"
}

ebgp-multihop_schema:

Allow EBGP neighbors not on directly connected networks

max-hop-count: integer: Maximum hop count
range:"1..255" default:"255"
mpls-deactivation: boolean: TRUE to not enable MPLS and NULL rewrite.

Example

{
  "max-hop-count": "integer",
  "mpls-deactivation": "boolean"
}

remote-as_schema:

Set remote AS

as-xx: string: xx of AS number xx.yy
as-yy: string: yy of AS number xx.yy

Example

{
  "as-xx": "string",
  "as-yy": "string"
}

local-as_schema:

Specify a local-as number

replace-as: null: Prepend only Local AS to announcements from this neighbor
dual-as: null: Dual-AS mode
no-prepend: null: Do not prepend Local AS to announcements from this neighbor
as-xx: string: xx of AS number xx.yy
disable: null: Disable Local AS and prevent it from being inherited from a parent
as-yy: string: yy of AS number xx.yy

Example

{
  "replace-as": [ null ],
  "dual-as": [ null ],
  "no-prepend": [ null ],
  "as-xx": "string",
  "disable": [ null ],
  "as-yy": "string"
}

password_schema:

Set or disable a password

password-disable: boolean: TRUE to prevent this entity from having a password even if the parent has one. FALSEto specify a password
password: string: The neighbor password. Leave unspecified when disabling the password.

Example

{
  "password-disable": "boolean",
  "password": "string"
}

advertisement-interval_schema:

Minimum interval between sending BGP routing updates

minimum-interval-msecs: integer: Minimum advertisement interval time, msecs part
range:"0..999" units:"millisecond"
minimum-interval: integer: Minimum advertisement interval time, secs part
range:"0..600" units:"second"

Example

{
  "minimum-interval-msecs": "integer",
  "minimum-interval": "integer"
}

neighbor-cluster-id_schema:

Neighbor Cluster-id

cluster-id-number: integer: Route-Reflector Cluster ID as 32 bit quantity
range:"0..4294967295"
cluster-id-address: string: Route-Reflector Cluster ID in IPV4 address format

Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

tcpmss_schema:

TCP Maximum segment size

tcpmss-disable: boolean: TRUE, to prevent inheritance ofTCP MSS valuefrom its parents.FALSE, otherwise
mss: integer: Maximum Segment Size
range:"68..10000"

Example

{
  "tcpmss-disable": "boolean",
  "mss": "integer"
}

tos_schema:

TOS (Type Of Service)

type: string precedence, dscp: Set type of service
value: string: TOS value to set

Example

{
  "type": "string",
  "value": "string"
}

update-in-filtering_schema:

Inbound update filtering

enable: null: Configure inbound update filtering
update-in-filtering-message-buffers: object: Message buffers to store filtered updates
update-in-filtering-syslog-disable: null: Disable inbound update filtering syslog messages
update-in-filtering-attribute-filter-group: string: Attribute-filter group name for update filtering

Example

{
  "enable": [ null ],
  "update-in-filtering-message-buffers": {
    "number-of-buffers": "integer",
    "non-circular-buffer": "boolean"
  },
  "update-in-filtering-syslog-disable": [ null ],
  "update-in-filtering-attribute-filter-group": "string"
}

update-in-filtering-message-buffers_schema:

Message buffers to store filtered updates

number-of-buffers: integer: Number of message buffers
range:"0..25"
non-circular-buffer: boolean: TRUE to configure non-circular buffer

Example

{
  "number-of-buffers": "integer",
  "non-circular-buffer": "boolean"
}

msg-log-out_schema:

Message log outbound

msg-log-inherit-disable: boolean: TRUE, to prevent this entity from having a outbound message logging if parent has one
msg-log-disable: boolean: Disable inbound message logging
msg-buf-count: integer: Outbound message log buffer size
range:"1..100"

Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

ao-keychain_schema:

Set or disable AO based authentication

ao-keychain-disable: boolean: TRUE to prevent this entity from having AO keychain based authentication even if the parent has one.FALSE to enable AO keychain based authentication
ao-include-tcp-options: boolean: Include TCP options header with AO
ao-accept-mismatch-connection: boolean: Accept new connections even though AO mismatched
ao-keychain-name: string: Name of the AO keychain associated with this neighbor

Example

{
  "ao-keychain-disable": "boolean",
  "ao-include-tcp-options": "boolean",
  "ao-accept-mismatch-connection": "boolean",
  "ao-keychain-name": "string"
}

receive-buffer-size_schema:

Set socket receive buffer size and BGP read buffer size

socket-receive-size: integer: Receive socket buffer size in bytes
range:"512..131072" units:"byte" default:"32768"
bgp-receive-size: integer: BGP read buffer size in bytes
range:"512..131072" units:"byte" default:"4096"

Example

{
  "socket-receive-size": "integer",
  "bgp-receive-size": "integer"
}

msg-log-in_schema:

Message log inbound

msg-log-inherit-disable: boolean: TRUE, to prevent this entity from having a inbound message logging if parent has one
msg-log-disable: boolean: Disable inbound message logging
msg-buf-count: integer: Inbound message log buffer size
range:"1..100"

Example

{
  "msg-log-inherit-disable": "boolean",
  "msg-log-disable": "boolean",
  "msg-buf-count": "integer"
}

send-buffer-size_schema:

Set socket send buffer size and BGP write buffer size

bgp-send-size: integer: BGP write buffer size in bytes
range:"4096..131072" units:"byte" default:"4096"
socket-send-size: integer: Send socket buffer size in bytes
range:"4096..131072" units:"byte" default:"24576"

Example

{
  "bgp-send-size": "integer",
  "socket-send-size": "integer"
}

timers_schema:

BGP per neighbor timers.

min-accept-hold-time: integer: Minimum acceptable hold time. Specify 0 to disable keepalives/hold time
range:"0..65535" units:"second" default:"3"
keepalive-interval: integer: Keepalive interval
range:"0..65535" default:"60"
hold-time: integer: Hold time. Specify 0 to disable keepalives/hold time
range:"0..65535" units:"second" default:"180"

Example

{
  "min-accept-hold-time": "integer",
  "keepalive-interval": "integer",
  "hold-time": "integer"
}

keychain_schema:

Set or disable keychain based authentication

keychain-name: string: Name of the keychain associated with neighbor
keychain-disable: boolean: TRUE to prevent this entity from having a keychain based authentication even if the parent has one.FALSE to specify a keychain name

Example

{
  "keychain-name": "string",
  "keychain-disable": "boolean"
}

graceful-maintenance_schema:

Graceful Maintenance mode

enable: null: Enter Graceful Maintenance mode to configure parametrs
graceful-maintenance-local-preference: object: Set Local Preference to advertise routes with
graceful-maintenance-activate: boolean: Initiate the graceful shutdown procedure
graceful-maintenance-as-prepends: object: Number of times to prepend local AS number to the AS path

Example

{
  "enable": [ null ],
  "graceful-maintenance-local-preference": {
    "local-preference": "integer",
    "gshut-loc-pref-disable": "boolean"
  },
  "graceful-maintenance-activate": "boolean",
  "graceful-maintenance-as-prepends": {
    "gshut-prepends-disable": "boolean",
    "as-prepends": "integer"
  }
}

graceful-maintenance-local-preference_schema:

Set Local Preference to advertise routes with

local-preference: integer: Local Preference Value
range:"0..4294967295" default:local preference"
gshut-loc-pref-disable: boolean: TRUE, to prevent inheritance of Local Pref value from its parents.FALSE, otherwise

Example

{
  "local-preference": "integer",
  "gshut-loc-pref-disable": "boolean"
}

graceful-maintenance-as-prepends_schema:

Number of times to prepend local AS number to the AS path

gshut-prepends-disable: boolean: TRUE, to prevent inheritance of AS Prepends value from its parents.FALSE, otherwise
as-prepends: integer: number of times AS prepends
range:"0..6"

Example

{
  "gshut-prepends-disable": "boolean",
  "as-prepends": "integer"
}

vrf-neighbor-prefix-length_schema:

VRF-NEIGHBOR-CONTENT

neighbor-address: string: Neighbor address
prefix-length: integer: Prefix length
range:"0..127"

Example

{
  "neighbor-address": "string",
  "prefix-length": "integer"
}

default-vrf_schema:

Global default config

global:: Global default config
bgp-entity: object: Neighbor, neighbor-group, af-group and session-group configuration

Example

{
  "global": {
    "mvpn": [ null ],
    "rpki-origin-as-validation-disable": [ null ],
    "rpki-static-routes": {
      "rpki-static-route": [
        {
          "addrress": "string",
          "as": "integer",
          "minimum": "integer",
          "maximum": "integer"
        }
      ]
    },
    "update-error-handling-extended-ibgp": [ null ],
    "install-diversion": [ null ],
    "attribute-filter-groups": {
      "attribute-filter-group": [
        {
          "enable": [ null ],
          "attribute-filter-group-name": "string",
          "attribute-filters": {
            "attribute-filter": [
              {
                "attribute-start": "string",
                "attribute-end": "string",
                "filter-action": "string"
              }
            ]
          }
        }
      ]
    },
    "update-limit-process": "integer",
    "rpki-origin-as-validation-time": "integer",
    "nsr": "boolean",
    "read-only": [ null ],
    "graceful-restart-stalepath-time": "integer",
    "graceful-reset": [ null ],
    "update-out-logging": [ null ],
    "graceful-restart-time": "integer",
    "confederation-domain": {
      "as-xx": "string",
      "as-yy": "string"
    },
    "global-graceful-maintenance-activate": {
      "retain-routes": "boolean",
      "all-neighbors": "boolean"
    },
    "graceful-restart-purge-time": "integer",
    "confederation-peer-ases": {
      "confederation-peer-as": [
        {
          "as-xx": "string",
          "as-yy": "string"
        }
      ]
    },
    "update-error-handling-basic-ebgp-disable": [ null ],
    "igp-loop-check": [ null ],
    "write-limit": {
      "formatted-messages": "integer",
      "desynchronize": "boolean",
      "enqueued-messages": "integer"
    },
    "rpki-bestpath-use-origin-as-validity": [ null ],
    "cluster-id": {
      "cluster-id-number": "integer",
      "cluster-id-address": "string"
    },
    "as-league": {
      "peers": {
        "peer": [
          {
            "as-xx": "string",
            "as-yy": "string"
          }
        ]
      },
      "enable": [ null ]
    },
    "enforce-ibgp-out-policy": [ null ],
    "rpki-servers": {
      "rpki-server": [
        {
          "username": "string",
          "password": "string",
          "enable": [ null ],
          "response-time": "integer",
          "refresh-time": "integer",
          "server": "string",
          "shutdown": [ null ],
          "purge-time": "integer",
          "transport": {
            "port": "string",
            "transport": "string"
          }
        }
      ]
    },
    "update-delay": {
      "delay": "integer",
      "always": "boolean"
    },
    "update-error-handling-basic-ibgp-disable": [ null ],
    "next-hop-trigger-delay": "integer",
    "as-list-groups": {
      "as-list-group": [
        {
          "ases": {
            "as": [
              {
                "as-xx": "string",
                "as-yy": "string"
              }
            ]
          },
          "enable": [ null ],
          "as-list-group-name": "string"
        }
      ]
    },
    "limits": {
      "maximum-neighbors": "integer"
    },
    "rpki-bestpath-origin-as-allow-invalid": [ null ],
    "global-afs": {
      "global-af": [
        null
      ]
    },
    "local-preference": "integer"
  }
}

bgp-entity_schema:

Neighbor, neighbor-group, af-group and session-group configuration

neighbors: object: Neighbor configuration
neighbor-groups: object: Neighbor-group configuration
af-groups: object: AF-group configuration
session-groups: object: Session group configuration

Example

{
  "neighbors": {
    "neighbor-prefix-length": [
      {
        "neighbor-address": "string",
        "prefix-length": "integer"
      }
    ],
    "neighbor": [
      {
        "neighbor-address": "string"
      }
    ]
  },
  "neighbor-groups": {
    "neighbor-group": [
      {
        "neighbor-group-afs": {
          "neighbor-group-af": [
            {
              "af-name": "string",
              "advertise-vrf-imp-disable-v4": {
                "af-name": "string",
                "rt-type": "string",
                "adv-option": "string"
              }
            }
          ]
        },
        "neighbor-group-name": "string",
        "neighbor-group-add-member": "string",
        "graceful-maintenance": {
          "enable": [ null ],
          "graceful-maintenance-local-preference": {
            "local-preference": "integer",
            "gshut-loc-pref-disable": "boolean"
          },
          "graceful-maintenance-activate": "boolean",
          "graceful-maintenance-as-prepends": {
            "gshut-prepends-disable": "boolean",
            "as-prepends": "integer"
          }
        }
      }
    ]
  },
  "af-groups": {
    "af-group": [
      {
        "af-group-name": "string",
        "af-group-afs": {
          "af-group-af": [
            {
              "af-name": "string",
              "create": [ null ],
              "af-group": "string",
              "advertise-vrf-imp-disable-v4": {
                "af-name": "string",
                "rt-type": "string",
                "adv-option": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "session-groups": {
    "session-group": [
      {
        "session-group-name": "string",
        "session-group-add-member": "string",
        "graceful-maintenance": {
          "enable": [ null ],
          "graceful-maintenance-local-preference": {
            "local-preference": "integer",
            "gshut-loc-pref-disable": "boolean"
          },
          "graceful-maintenance-activate": "boolean",
          "graceful-maintenance-as-prepends": {
            "gshut-prepends-disable": "boolean",
            "as-prepends": "integer"
          }
        }
      }
    ]
  }
}

neighbors_schema:

Neighbor configuration

neighbor-prefix-length: object[]: A particular BGP peer
neighbor: object[]: A particular BGP peer

Example

{
  "neighbor-prefix-length": [
    {
      "neighbor-address": "string",
      "prefix-length": "integer"
    }
  ],
  "neighbor": [
    {
      "neighbor-address": "string"
    }
  ]
}

neighbor_schema:

NEIGHBOR-CONTENT

neighbor-address: string: Neighbor address

Example

{
  "neighbor-address": "string"
}

neighbor-afs_schema:

BGP neighbor AF configuration table

neighbor-af: ADVERTISE-VRF-IMP-DISABLE-V4: Address family type of neighbor

Example

{
  "neighbor-af": [
    {
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

neighbor-prefix-length_schema:

NEIGHBOR-CONTENT

neighbor-address: string: Neighbor address
prefix-length: integer: Prefix length
range:"0..127"

Example

{
  "neighbor-address": "string",
  "prefix-length": "integer"
}

neighbor-groups_schema:

Neighbor-group configuration

neighbor-group: object[]: A particular BGP neighbor group

Example

{
  "neighbor-group": [
    {
      "neighbor-group-afs": {
        "neighbor-group-af": [
          {
            "af-name": "string",
            "advertise-vrf-imp-disable-v4": {
              "af-name": "string",
              "rt-type": "string",
              "adv-option": "string"
            }
          }
        ]
      },
      "neighbor-group-name": "string",
      "neighbor-group-add-member": "string",
      "graceful-maintenance": {
        "enable": [ null ],
        "graceful-maintenance-local-preference": {
          "local-preference": "integer",
          "gshut-loc-pref-disable": "boolean"
        },
        "graceful-maintenance-activate": "boolean",
        "graceful-maintenance-as-prepends": {
          "gshut-prepends-disable": "boolean",
          "as-prepends": "integer"
        }
      }
    }
  ]
}

neighbor-group_schema:

GRACEFUL-MAINTENANCE

neighbor-group-afs: object: BGP neighbor-group AF configuration table
neighbor-group-name: string: BGP neighbor group name
neighbor-group-add-member: string: Inherit configuration from a neighbor-group

Example

{
  "neighbor-group-afs": {
    "neighbor-group-af": [
      {
        "af-name": "string",
        "advertise-vrf-imp-disable-v4": {
          "af-name": "string",
          "rt-type": "string",
          "adv-option": "string"
        }
      }
    ]
  },
  "neighbor-group-name": "string",
  "neighbor-group-add-member": "string",
  "graceful-maintenance": {
    "enable": [ null ],
    "graceful-maintenance-local-preference": {
      "local-preference": "integer",
      "gshut-loc-pref-disable": "boolean"
    },
    "graceful-maintenance-activate": "boolean",
    "graceful-maintenance-as-prepends": {
      "gshut-prepends-disable": "boolean",
      "as-prepends": "integer"
    }
  }
}

neighbor-group-afs_schema:

BGP neighbor-group AF configuration table

neighbor-group-af: object[]: Address family type of neighbor group

Example

{
  "neighbor-group-af": [
    {
      "af-name": "string",
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

neighbor-group-af_schema:

ADVERTISE-VRF-IMP-DISABLE-V4

af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: BGP neighbor group address family

Example

{
  "af-name": "string",
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

af-groups_schema:

AF-group configuration

af-group: object[]: A particular BGP AF group

Example

{
  "af-group": [
    {
      "af-group-name": "string",
      "af-group-afs": {
        "af-group-af": [
          {
            "af-name": "string",
            "create": [ null ],
            "af-group": "string",
            "advertise-vrf-imp-disable-v4": {
              "af-name": "string",
              "rt-type": "string",
              "adv-option": "string"
            }
          }
        ]
      }
    }
  ]
}

af-group_schema:

af-group-name: string: BGP AF group name
af-group-afs: object: AF group configuration table

Example

{
  "af-group-name": "string",
  "af-group-afs": {
    "af-group-af": [
      {
        "af-name": "string",
        "create": [ null ],
        "af-group": "string",
        "advertise-vrf-imp-disable-v4": {
          "af-name": "string",
          "rt-type": "string",
          "adv-option": "string"
        }
      }
    ]
  }
}

af-group-afs_schema:

AF group configuration table

af-group-af: object[]: Address family type of an AF group

Example

{
  "af-group-af": [
    {
      "af-name": "string",
      "create": [ null ],
      "af-group": "string",
      "advertise-vrf-imp-disable-v4": {
        "af-name": "string",
        "rt-type": "string",
        "adv-option": "string"
      }
    }
  ]
}

af-group-af_schema:

ADVERTISE-VRF-IMP-DISABLE-V4

af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: BGP AF group address family
create: null: Create this address family group. Deletion of this object causes deletion of all the objects under AFGroup associated with this object.
af-group: string: Inherit configuration for this address-family from an AF-group

Example

{
  "af-name": "string",
  "create": [ null ],
  "af-group": "string",
  "advertise-vrf-imp-disable-v4": {
    "af-name": "string",
    "rt-type": "string",
    "adv-option": "string"
  }
}

session-groups_schema:

Session group configuration

session-group: object[]: A particular BGP session group

Example

{
  "session-group": [
    {
      "session-group-name": "string",
      "session-group-add-member": "string",
      "graceful-maintenance": {
        "enable": [ null ],
        "graceful-maintenance-local-preference": {
          "local-preference": "integer",
          "gshut-loc-pref-disable": "boolean"
        },
        "graceful-maintenance-activate": "boolean",
        "graceful-maintenance-as-prepends": {
          "gshut-prepends-disable": "boolean",
          "as-prepends": "integer"
        }
      }
    }
  ]
}

session-group_schema:

GRACEFUL-MAINTENANCE

session-group-name: string: BGP session group name
session-group-add-member: string: Inherit address-family independent config from a session-group

Example

{
  "session-group-name": "string",
  "session-group-add-member": "string",
  "graceful-maintenance": {
    "enable": [ null ],
    "graceful-maintenance-local-preference": {
      "local-preference": "integer",
      "gshut-loc-pref-disable": "boolean"
    },
    "graceful-maintenance-activate": "boolean",
    "graceful-maintenance-as-prepends": {
      "gshut-prepends-disable": "boolean",
      "as-prepends": "integer"
    }
  }
}

global_schema:

Global default config

LOCAL-PREFERENCE

mvpn: null: Connect to PIM/PIM6
rpki-origin-as-validation-disable: null: RPKI origin-AS validation disable
rpki-static-routes: object: RPKI static route configuration
update-error-handling-extended-ibgp: null: Inbound update extended error-handling for IBGP neighbors
install-diversion: null: Install diversion path to RIB/CEF
attribute-filter-groups: object: Attribute-filter groups list
update-limit-process: integer: Upper bound on update generation transient memory usage for the process
range:"16..2048" units:"megabyte" default:"512"
rpki-origin-as-validation-time: integer: Prefix validation time (in seconds). Range : 5 - 60. Specify 0 to disable the timer
range:"0..60" units:"second"
nsr: boolean: TRUE to Enable non-stop routing supportFALSE to Disable non-stop routing support
read-only: null: Allow duplicate table config and disable update generation
graceful-restart-stalepath-time: integer: Maximum time to wait for restart of GR capable peers
range:"1..4095" units:"second" default:"360"
graceful-reset: null: Reset gracefully if configuration change forces a peer reset
update-out-logging: null: Enables logging of update generation events
graceful-restart-time: integer: Restart time advertised to neighbors
range:"1..4095" units:"second" default:"120"
confederation-domain: object: Set routing domain confederation AS
global-graceful-maintenance-activate: object: Activate Graceful Maintenance Mode for all neighbors with graceful maintenance config
graceful-restart-purge-time: integer: Time before stale routes are purged.
range:"1..6000" units:"second" default:"600"
confederation-peer-ases: object: Define peer ASes in BGP confederation
update-error-handling-basic-ebgp-disable: null: Inbound update basic error-handling for EBGP neighbors
igp-loop-check: null: Enable AS-path loop checking for iBGP peers
write-limit: object: Set write-queue limit for each update group
rpki-bestpath-use-origin-as-validity: null: RPKI bestpath use origin-AS validity
cluster-id: object: Configure Route-Reflector Cluster-id
as-league: object: AS League
enforce-ibgp-out-policy: null: Allow all attributes to be modified by outbound policy for iBGP peers
rpki-servers: object: RPKI server configuration
update-delay: object: Set the max initial delay for sending updates
update-error-handling-basic-ibgp-disable: null: Inbound update basic error-handling for IBGP neighbors
next-hop-trigger-delay: integer: Set the delay for triggering nexthop recalculations
range:"0..300" units:"second" default:"5"
as-list-groups: object: AS-list group lists
limits: object: Maximum number that can be configured
rpki-bestpath-origin-as-allow-invalid: null: RPKI bestpath origin-AS allow invalid
global-afs: object: Global AF-specific configuration
neighbor-logging-detail: null: Include extra detail in neighbor change messages
update-error-handling-extended-ebgp: null: Inbound update extended error-handling for EBGP neighbors
global-scan-time: integer: Configure background scanner interval for generic scanner
range:"5..3600" units:"second" default:"60"
rpki-origin-as-validity-signal-ibgp: null: RPKI origin-AS validity signal ibgp
graceful-restart: null: Enable graceful restart support

Example

{
  "mvpn": [ null ],
  "rpki-origin-as-validation-disable": [ null ],
  "rpki-static-routes": {
    "rpki-static-route": [
      {
        "addrress": "string",
        "as": "integer",
        "minimum": "integer",
        "maximum": "integer"
      }
    ]
  },
  "update-error-handling-extended-ibgp": [ null ],
  "install-diversion": [ null ],
  "attribute-filter-groups": {
    "attribute-filter-group": [
      {
        "enable": [ null ],
        "attribute-filter-group-name": "string",
        "attribute-filters": {
          "attribute-filter": [
            {
              "attribute-start": "string",
              "attribute-end": "string",
              "filter-action": "string"
            }
          ]
        }
      }
    ]
  },
  "update-limit-process": "integer",
  "rpki-origin-as-validation-time": "integer",
  "nsr": "boolean",
  "read-only": [ null ],
  "graceful-restart-stalepath-time": "integer",
  "graceful-reset": [ null ],
  "update-out-logging": [ null ],
  "graceful-restart-time": "integer",
  "confederation-domain": {
    "as-xx": "string",
    "as-yy": "string"
  },
  "global-graceful-maintenance-activate": {
    "retain-routes": "boolean",
    "all-neighbors": "boolean"
  },
  "graceful-restart-purge-time": "integer",
  "confederation-peer-ases": {
    "confederation-peer-as": [
      {
        "as-xx": "string",
        "as-yy": "string"
      }
    ]
  },
  "update-error-handling-basic-ebgp-disable": [ null ],
  "igp-loop-check": [ null ],
  "write-limit": {
    "formatted-messages": "integer",
    "desynchronize": "boolean",
    "enqueued-messages": "integer"
  },
  "rpki-bestpath-use-origin-as-validity": [ null ],
  "cluster-id": {
    "cluster-id-number": "integer",
    "cluster-id-address": "string"
  },
  "as-league": {
    "peers": {
      "peer": [
        {
          "as-xx": "string",
          "as-yy": "string"
        }
      ]
    },
    "enable": [ null ]
  },
  "enforce-ibgp-out-policy": [ null ],
  "rpki-servers": {
    "rpki-server": [
      {
        "username": "string",
        "password": "string",
        "enable": [ null ],
        "response-time": "integer",
        "refresh-time": "integer",
        "server": "string",
        "shutdown": [ null ],
        "purge-time": "integer",
        "transport": {
          "port": "string",
          "transport": "string"
        }
      }
    ]
  },
  "update-delay": {
    "delay": "integer",
    "always": "boolean"
  },
  "update-error-handling-basic-ibgp-disable": [ null ],
  "next-hop-trigger-delay": "integer",
  "as-list-groups": {
    "as-list-group": [
      {
        "ases": {
          "as": [
            {
              "as-xx": "string",
              "as-yy": "string"
            }
          ]
        },
        "enable": [ null ],
        "as-list-group-name": "string"
      }
    ]
  },
  "limits": {
    "maximum-neighbors": "integer"
  },
  "rpki-bestpath-origin-as-allow-invalid": [ null ],
  "global-afs": {
    "global-af": [
      {}
    ]
  },
  "local-preference": "integer"
}

cluster-id_schema:

Configure Route-Reflector Cluster-id

cluster-id-number: integer: Route-Reflector Cluster ID as 32 bit quantity
range:"0..4294967295"
cluster-id-address: string: Route-Reflector Cluster ID in IPV4 address format

Example

{
  "cluster-id-number": "integer",
  "cluster-id-address": "string"
}

write-limit_schema:

Set write-queue limit for each update group

formatted-messages: integer: Number of messages to be formatted per update group
range:"500..100000000" default:"50000"
desynchronize: boolean: TRUE to enable desynchronization, FALSE otherwise.
enqueued-messages: integer: Number of messages that can be enqueued in total
range:"500..100000000" default:"250000"

Example

{
  "formatted-messages": "integer",
  "desynchronize": "boolean",
  "enqueued-messages": "integer"
}

update-delay_schema:

Set the max initial delay for sending updates

delay: integer: Delay value (seconds)
range:"1..3600" units:"second" default:"120"
always: boolean: Set to TRUE to disable keepalive trigger bestpath and delay is enforced.

Example

{
  "delay": "integer",
  "always": "boolean"
}

as-league_schema:

AS League

peers: object: AS League Peers
enable: null: AS League creation

Example

{
  "peers": {
    "peer": [
      {
        "as-xx": "string",
        "as-yy": "string"
      }
    ]
  },
  "enable": [ null ]
}

peers_schema:

AS League Peers

peer: object[]: AS League Peer AS

Example

{
  "peer": [
    {
      "as-xx": "string",
      "as-yy": "string"
    }
  ]
}

peer_schema:

as-xx: string: xx of peer AS xx.yy
as-yy: string: yy of peer AS xx.yy

Example

{
  "as-xx": "string",
  "as-yy": "string"
}

rpki-servers_schema:

RPKI server configuration

rpki-server: object[]: RPKI server configuration

Example

{
  "rpki-server": [
    {
      "username": "string",
      "password": "string",
      "enable": [ null ],
      "response-time": "integer",
      "refresh-time": "integer",
      "server": "string",
      "shutdown": [ null ],
      "purge-time": "integer",
      "transport": {
        "port": "string",
        "transport": "string"
      }
    }
  ]
}

rpki-server_schema:

username: string: RPKI server username
password: string: RPKI server password
enable: null: RPKI server configuration
response-time: integer: RPKI server response-time (15-3600 seconds)
range:"15..3600" units:"second"
refresh-time: integer: RPKI server refresh-time (15-3600 seconds)
range:"15..3600" units:"second"
server: string: Server address (opaque string)
shutdown: null: RPKI server shutdown
purge-time: integer: RPKI server purge-time (30-360 seconds)
range:"30..360" units:"second"
transport: object: RPKI server transport

Example

{
  "username": "string",
  "password": "string",
  "enable": [ null ],
  "response-time": "integer",
  "refresh-time": "integer",
  "server": "string",
  "shutdown": [ null ],
  "purge-time": "integer",
  "transport": {
    "port": "string",
    "transport": "string"
  }
}

transport_schema:

RPKI server transport

port: string: port
transport: string tcp, ssh: RPKI server transport

Example

{
  "port": "string",
  "transport": "string"
}

as-list-groups_schema:

AS-list group lists

as-list-group: object[]: AS-List group

Example

{
  "as-list-group": [
    {
      "ases": {
        "as": [
          {
            "as-xx": "string",
            "as-yy": "string"
          }
        ]
      },
      "enable": [ null ],
      "as-list-group-name": "string"
    }
  ]
}

as-list-group_schema:

ases: object: AS list
enable: null: AS-List group creation
as-list-group-name: string: Group name

Example

{
  "ases": {
    "as": [
      {
        "as-xx": "string",
        "as-yy": "string"
      }
    ]
  },
  "enable": [ null ],
  "as-list-group-name": "string"
}

ases_schema:

AS list

as: object[]: AS-List group

Example

{
  "as": [
    {
      "as-xx": "string",
      "as-yy": "string"
    }
  ]
}

as_schema:

as-xx: string: xx of AS number/confed peer xx.yy
as-yy: string: yy of AS number/confed peer xx.yy

Example

{
  "as-xx": "string",
  "as-yy": "string"
}

limits_schema:

Maximum number that can be configured

maximum-neighbors: integer: Maximum number of neighbors that can be configured
range:"1..15000" default:"10000"

Example

{
  "maximum-neighbors": "integer"
}

confederation-domain_schema:

Set routing domain confederation AS

as-xx: string: xx of AS number xx.yy
as-yy: string: yy of AS number xx.yy

Example

{
  "as-xx": "string",
  "as-yy": "string"
}

confederation-peer-ases_schema:

Define peer ASes in BGP confederation

confederation-peer-as: object[]: Confederation peer AS

Example

{
  "confederation-peer-as": [
    {
      "as-xx": "string",
      "as-yy": "string"
    }
  ]
}

confederation-peer-as_schema:

as-xx: string: xx of AS number/confed peer xx.yy
as-yy: string: yy of AS number/confed peer xx.yy

Example

{
  "as-xx": "string",
  "as-yy": "string"
}

attribute-filter-groups_schema:

Attribute-filter groups list

attribute-filter-group: object[]: Attribute-filter group

Example

{
  "attribute-filter-group": [
    {
      "enable": [ null ],
      "attribute-filter-group-name": "string",
      "attribute-filters": {
        "attribute-filter": [
          {
            "attribute-start": "string",
            "attribute-end": "string",
            "filter-action": "string"
          }
        ]
      }
    }
  ]
}

attribute-filter-group_schema:

enable: null: Attribute-filter group creation
attribute-filter-group-name: string: Group name
attribute-filters: object: Attribute-filter group attributes list

Example

{
  "enable": [ null ],
  "attribute-filter-group-name": "string",
  "attribute-filters": {
    "attribute-filter": [
      {
        "attribute-start": "string",
        "attribute-end": "string",
        "filter-action": "string"
      }
    ]
  }
}

attribute-filters_schema:

Attribute-filter group attributes list

attribute-filter: object[]: Attribute-filter group attribute

Example

{
  "attribute-filter": [
    {
      "attribute-start": "string",
      "attribute-end": "string",
      "filter-action": "string"
    }
  ]
}

attribute-filter_schema:

attribute-start: string: Start of attribute range
attribute-end: string: End of attribute range
filter-action: string: Filtering action

Example

{
  "attribute-start": "string",
  "attribute-end": "string",
  "filter-action": "string"
}

global-graceful-maintenance-activate_schema:

Activate Graceful Maintenance Mode for all neighbors with graceful maintenance config

retain-routes: boolean: Keep routes in RIB once BGP stops
all-neighbors: boolean: Also for neighbors without graceful maintenance config

Example

{
  "retain-routes": "boolean",
  "all-neighbors": "boolean"
}

global-afs_schema:

Global AF-specific configuration

global-af: object[]: Global AF-specific configuration

Example

{
  "global-af": [
    {
      "isis-routes": {
        "isis-route": [
          {
            "default-metric": "string",
            "route-policy-name": "string",
            "redist-type": "string",
            "instance-name": "string"
          }
        ]
      },
      "global-table-mcast": [ null ],
      "update-limit-sub-group-ebgp": "integer",
      "domain-distinguisher": {
        "as": "string",
        "router-id": "string"
      },
      "segmented-mcast": [ null ],
      "inter-as-install": [ null ],
      "rpki-origin-as-validation-disable": [ null ],
      "disable-client-to-client-rr": [ null ],
      "disable-cluster-client-to-client-rrs": {
        "disable-cluster-client-to-client-rr": [
          {
            "ipv4-address": [
              {
                "cluster-id-address": "string"
              }
            ],
            "cluster-type": "string",
            "number": [
              {
                "cluster-id-number": "integer"
              }
            ]
          }
        ]
      },
      "label-delay": {
        "seconds": "integer",
        "milliseconds": "integer"
      },
      "rnh-install-format": "string",
      "implicit-import": [ null ],
      "label-security-rpf": [ null ],
      "use-igpsr-label": [ null ],
      "wait-rib-install": [ null ],
      "ibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "next-hop-non-critical-trigger-delay": "integer",
      "label-retain": "integer",
      "import-delay": {
        "seconds": "integer",
        "milliseconds": "integer"
      },
      "retain-rt": {
        "all": "boolean",
        "route-policy-name": "string"
      },
      "source-route-target-policy": "string",
      "rpki-bestpath-use-origin-as-validity": [ null ],
      "prefix-sid-map": [ null ],
      "scan-time": "integer",
      "vrf-all": {
        "rnh-install-format": "string",
        "enable": [ null ],
        "srv6-label-allocation-mode": "string",
        "table-policy": "string",
        "source-rt-import-policy": [ null ],
        "label-mode": {
          "route-policy-name": "string",
          "label-allocation-mode": "string"
        }
      },
      "update-limit-sub-group-ibgp": "integer",
      "update-limit-address-family": "integer",
      "eibgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "rpki-bestpath-origin-as-allow-invalid": [ null ],
      "next-hop-route-policy": "string",
      "disable-default-martian-check": [ null ],
      "af-name": "string",
      "next-hop-critical-trigger-delay": "integer",
      "ebgp": {
        "order-by-igp-metric": "boolean",
        "paths-value": "integer",
        "selective": "boolean",
        "unequal-cost": "boolean"
      },
      "rpki-origin-as-validity-signal-ibgp": [ null ],
      "subscriber-routes": {
        "default-metric": "string",
        "route-policy-name": "string",
        "not-used": "integer"
      }
    }
  ]
}

global-af_schema:

SUBSCRIBER-ROUTES

isis-routes: object: Redistribute information for IS-IS routes .
global-table-mcast: null: Enable global table multicast
update-limit-sub-group-ebgp: integer: Upper bound on update generation transient memory usage for every EBGP Sub-group
range:"1..512" units:"megabyte" default:"32"
domain-distinguisher: object: <ASN, router-id> tuple to use to identify the link-state domain
segmented-mcast: null: Enable segmented multicast
inter-as-install: null: Enable install remote MVPN routes to PIM in default VRF
rpki-origin-as-validation-disable: null: RPKI origin-AS validation disable
disable-client-to-client-rr: null: Disable client-to-client reflection
disable-cluster-client-to-client-rrs: object: Disable client-to-client reflection for a cluster
label-delay: object: Delay timer to batch label processing.
rnh-install-format: string ext-comm, ext-comm-only: RNH install format type: extcomm - install rnh as opaque and extcomms, extcomm-only - install rnh as extcomms only
implicit-import: null: Implicit import configuration
label-security-rpf: null: Calculate label-security RPF lists and install to RIB/LSD
use-igpsr-label: null: Use IGP SR label for resolution configuration
wait-rib-install: null: Wait for route install before sending updates to neighbors
ibgp: object: Use iBGP multipaths
next-hop-non-critical-trigger-delay: integer: Next hop Non-critical Trigger Delay
range:"0..4294967295" units:"millisecond" default:"10000"
label-retain: integer: Label retention time in minutes
range:"3..60" units:"minute"
import-delay: object: Delay timer to batch import processing.
retain-rt: object: Accept received updates with the specified attributes
source-route-target-policy: string: Route policy name to apply to configure source route-target
rpki-bestpath-use-origin-as-validity: null: RPKI bestpath use origin-AS validity
prefix-sid-map: null: Retrieve prefix sid mapping from SRMS
scan-time: integer: Configure background scanner interval for this address family
range:"5..3600" units:"second" default:"60"
vrf-all: object: Configurations to be inherited to all vrfs
update-limit-sub-group-ibgp: integer: Upper bound on update generation transient memory usage for every IBGP Sub-group
range:"1..512" units:"megabyte" default:"32"
update-limit-address-family: integer: Upper bound on update generation transient memory usage for the address-family
range:"4..2048" units:"megabyte" default:"256"
eibgp: object: Use eiBGP multipaths
rpki-bestpath-origin-as-allow-invalid: null: RPKI bestpath origin-AS allow invalid
next-hop-route-policy: string: Next hop policy to filter out nexthop notification
disable-default-martian-check: null: Disable default Martian Check
af-name: string ipv4-unicast, ipv4-multicast, ipv4-labeled-unicast, ipv4-tunnel, vpnv4-unicast, ipv6-unicast, ipv6-multicast, ipv6-labeled-unicast, vpnv6-unicast, ipv4-mdt, l2vpn-vpls, ipv4rt-constraint, ipv4-mvpn, ipv6-mvpn, l2vpn-evpn, lsls, vpnv4-multicast, vpnv6-multicast, ipv4-flowspec, ipv6-flowspec, vpnv4-flowspec, vpnv6-flowspec, l2vpn-mspw, ipv4-sr-policy, ipv6-sr-policy, all-address-family: Address family
next-hop-critical-trigger-delay: integer: Next hop Critical Trigger Delay
range:"0..4294967295" units:"millisecond" default:"3000"
ebgp: object: Use eBGP multipaths
rpki-origin-as-validity-signal-ibgp: null: RPKI origin-AS validity signal ibgp

Example

{
  "isis-routes": {
    "isis-route": [
      {
        "default-metric": "string",
        "route-policy-name": "string",
        "redist-type": "string",
        "instance-name": "string"
      }
    ]
  },
  "global-table-mcast": [ null ],
  "update-limit-sub-group-ebgp": "integer",
  "domain-distinguisher": {
    "as": "string",
    "router-id": "string"
  },
  "segmented-mcast": [ null ],
  "inter-as-install": [ null ],
  "rpki-origin-as-validation-disable": [ null ],
  "disable-client-to-client-rr": [ null ],
  "disable-cluster-client-to-client-rrs": {
    "disable-cluster-client-to-client-rr": [
      {
        "ipv4-address": [
          {
            "cluster-id-address": "string"
          }
        ],
        "cluster-type": "string",
        "number": [
          {
            "cluster-id-number": "integer"
          }
        ]
      }
    ]
  },
  "label-delay": {
    "seconds": "integer",
    "milliseconds": "integer"
  },
  "rnh-install-format": "string",
  "implicit-import": [ null ],
  "label-security-rpf": [ null ],
  "use-igpsr-label": [ null ],
  "wait-rib-install": [ null ],
  "ibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "next-hop-non-critical-trigger-delay": "integer",
  "label-retain": "integer",
  "import-delay": {
    "seconds": "integer",
    "milliseconds": "integer"
  },
  "retain-rt": {
    "all": "boolean",
    "route-policy-name": "string"
  },
  "source-route-target-policy": "string",
  "rpki-bestpath-use-origin-as-validity": [ null ],
  "prefix-sid-map": [ null ],
  "scan-time": "integer",
  "vrf-all": {
    "rnh-install-format": "string",
    "enable": [ null ],
    "srv6-label-allocation-mode": "string",
    "table-policy": "string",
    "source-rt-import-policy": [ null ],
    "label-mode": {
      "route-policy-name": "string",
      "label-allocation-mode": "string"
    }
  },
  "update-limit-sub-group-ibgp": "integer",
  "update-limit-address-family": "integer",
  "eibgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "rpki-bestpath-origin-as-allow-invalid": [ null ],
  "next-hop-route-policy": "string",
  "disable-default-martian-check": [ null ],
  "af-name": "string",
  "next-hop-critical-trigger-delay": "integer",
  "ebgp": {
    "order-by-igp-metric": "boolean",
    "paths-value": "integer",
    "selective": "boolean",
    "unequal-cost": "boolean"
  },
  "rpki-origin-as-validity-signal-ibgp": [ null ],
  "subscriber-routes": {
    "default-metric": "string",
    "route-policy-name": "string",
    "not-used": "integer"
  }
}

isis-routes_schema:

Redistribute information for IS-IS routes .

isis-route: object[]: Redistribute IS-IS routes

Example

{
  "isis-route": [
    {
      "default-metric": "string",
      "route-policy-name": "string",
      "redist-type": "string",
      "instance-name": "string"
    }
  ]
}

isis-route_schema:

default-metric: string: Default metric
route-policy-name: string: Route policy name
redist-type: string: Redistribution type: 01 for level 1 routes, 02 for level 2 routes, 04 for level 1 inter-area routes. Logical combinations permitted.
instance-name: string: IS-IS instance name

Example

{
  "default-metric": "string",
  "route-policy-name": "string",
  "redist-type": "string",
  "instance-name": "string"
}

domain-distinguisher_schema:

<ASN, router-id> tuple to use to identify the link-state domain

as: string: AS Number
router-id: string: Router ID

Example

{
  "as": "string",
  "router-id": "string"
}

vrf-all_schema:

Configurations to be inherited to all vrfs

rnh-install-format: string ext-comm, ext-comm-only: RNH install format type: extcomm - install rnh as opaque and extcomms, extcomm-only - install rnh as extcomms only
enable: null: Enable vrf all configuration submode
srv6-label-allocation-mode: string: Label allocation mode: per-ce Set per CE label mode,per-vrf Set per VRF label mode
table-policy: string: Configure policy for installation of routes to RIB
source-rt-import-policy: null: Enable sourcing of import route-targets from import-policy
label-mode: object: MPLS-VPN label allocation mode

Example

{
  "rnh-install-format": "string",
  "enable": [ null ],
  "srv6-label-allocation-mode": "string",
  "table-policy": "string",
  "source-rt-import-policy": [ null ],
  "label-mode": {
    "route-policy-name": "string",
    "label-allocation-mode": "string"
  }
}

disable-cluster-client-to-client-rrs_schema:

Disable client-to-client reflection for a cluster

disable-cluster-client-to-client-rr: object[]: Cluster ID for which reflection is to be disbled

Example

{
  "disable-cluster-client-to-client-rr": [
    {
      "ipv4-address": [
        {
          "cluster-id-address": "string"
        }
      ],
      "cluster-type": "string",
      "number": [
        {
          "cluster-id-number": "integer"
        }
      ]
    }
  ]
}

disable-cluster-client-to-client-rr_schema:

ipv4-address: object[]: ipv4 address
cluster-type: string number, ipv4-address: Type of cluster-id
number: object[]: number

Example

{
  "ipv4-address": [
    {
      "cluster-id-address": "string"
    }
  ],
  "cluster-type": "string",
  "number": [
    {
      "cluster-id-number": "integer"
    }
  ]
}

number_schema:

cluster-id-number: integer: Cluster ID: if configured as a number
range:"0..4294967295"

Example

{
  "cluster-id-number": "integer"
}

ipv4-address_schema:

cluster-id-address: string: Cluster ID: if configured as an IP Address

Example

{
  "cluster-id-address": "string"
}

label-delay_schema:

Delay timer to batch label processing.

seconds: integer: Delay, seconds part
range:"0..10" units:"second"
milliseconds: integer: Delay, milliseconds part
range:"0..999" units:"millisecond"

Example

{
  "seconds": "integer",
  "milliseconds": "integer"
}

retain-rt_schema:

Accept received updates with the specified attributes

all: boolean: Whether all RTs are to be retained, default is FALSE
route-policy-name: string: Route policy name

Example

{
  "all": "boolean",
  "route-policy-name": "string"
}

import-delay_schema:

Delay timer to batch import processing.

seconds: integer: Delay, seconds part
range:"0..10" units:"second"
milliseconds: integer: Delay, milliseconds part
range:"0..999" units:"millisecond"

Example

{
  "seconds": "integer",
  "milliseconds": "integer"
}

rpki-static-routes_schema:

RPKI static route configuration

rpki-static-route: object[]: RPKI static route

Example

{
  "rpki-static-route": [
    {
      "addrress": "string",
      "as": "integer",
      "minimum": "integer",
      "maximum": "integer"
    }
  ]
}

rpki-static-route_schema:

addrress: string: Address
as: integer: AS Number
range:"1..4294967295"
minimum: integer: Minimum Prefix Length
maximum: integer: Maximum Prefix Length

Example

{
  "addrress": "string",
  "as": "integer",
  "minimum": "integer",
  "maximum": "integer"
}

bmp-server-all_schema:

bmp server all

maximum-buffer-size: integer: Range in MegaBytes for the maximum buffer size of BMP message queue. The maximum buf-size is 20% and default buf-size is 15% of the platform virtual memory max-limit (aka rlimit). Please run show bgp process performance-statistics to see the individual values. Unit is in Megabytes
range:"1..4294967295" units:"megabyte"
route-monitoring: object: Enable Route Monitoring capability for the BMP servers. BGP update messages messages will be regenrated with a table walk

Example

{
  "maximum-buffer-size": "integer",
  "route-monitoring": {
    "policy": "string",
    "direction": "string"
  }
}

route-monitoring_schema:

Enable Route Monitoring capability for the BMP servers. BGP update messages messages will be regenrated with a table walk

policy: string post-policy: Specify if the routes packed in update messages should be before or after the application of route-policy
direction: string inbound: Specify if the routes should be picked up at inbound or outbound direction

Example

{
  "policy": "string",
  "direction": "string"
}

bmp-servers_schema:

bmp servers

bmp-server: object[]: A particular BMP server

Example

{
  "bmp-server": [
    {
      "host-port": {
        "host": "string",
        "port": "string"
      },
      "initial-refresh-delay": {
        "delay": "integer",
        "skip": [ null ],
        "spread": "integer"
      },
      "status-report-interval": "integer",
      "description": "string",
      "tos": {
        "type": "string",
        "value": "string"
      },
      "create": [ null ],
      "server-id": "integer",
      "bmptcp-keep-alive": "integer",
      "maximum-buffer-size": "integer",
      "initial-delay": "integer",
      "vrf": "string",
      "shutdown": [ null ],
      "update-source-interface": "string",
      "bmptcp-maximum-segment-size": "integer",
      "flapping-delay": "integer"
    }
  ]
}

bmp-server_schema:

host-port: object: Configure Host Name/Address and Port for BMP Server
initial-refresh-delay: object: Initial refresh to generate BGP updates
status-report-interval: integer: Stats reporting period for BMP server
range:"1..3600" units:"second"
description: string: String to describe the BMP server
tos: object: TOS (Type Of Service)
create: null: BMP Server Creation
server-id: integer: BMP Server ID
range:"1..8"
bmptcp-keep-alive: integer: configure TCP keep alives to be exchanged between client and server. Default=1000
range:"0..7200" units:"second"
maximum-buffer-size: integer: Range in MegaBytes for the maximum buffer size of BMP message queue. The maximum buf-size is 20% and default buf-size is 15% of the platform virtual memory max-limit (aka rlimit) . Please run show bgp process performance-statistics to see the individual values. Unit is in Megabytes
range:"1..4294967295" units:"megabyte"
initial-delay: integer: Initial connect delay in seconds in sending updates
range:"1..3600" units:"second"
vrf: string: VRF for BMP Server
shutdown: null: Shutdown connection to BMP server
update-source-interface: string: Select an interface to configure
bmptcp-maximum-segment-size: integer: configure TCP maximum segment size. Default=16384.
range:"68..10000" units:"byte"
flapping-delay: integer: Delay in connecting to BMP Server after a flap had been detected.
range:"60..3600" units:"second"

Example

{
  "host-port": {
    "host": "string",
    "port": "string"
  },
  "initial-refresh-delay": {
    "delay": "integer",
    "skip": [ null ],
    "spread": "integer"
  },
  "status-report-interval": "integer",
  "description": "string",
  "tos": {
    "type": "string",
    "value": "string"
  },
  "create": [ null ],
  "server-id": "integer",
  "bmptcp-keep-alive": "integer",
  "maximum-buffer-size": "integer",
  "initial-delay": "integer",
  "vrf": "string",
  "shutdown": [ null ],
  "update-source-interface": "string",
  "bmptcp-maximum-segment-size": "integer",
  "flapping-delay": "integer"
}

initial-refresh-delay_schema:

Initial refresh to generate BGP updates

delay: integer: Delay in seconds before sending Refresh request to Peers
range:"1..3600" units:"second" default:"120"
skip: null: Skip Route Refresh request to Peers
spread: integer: Spread over which to send initial Refresh request to Peers
range:"1..3600"

Example

{
  "delay": "integer",
  "skip": [ null ],
  "spread": "integer"
}

host-port_schema:

Configure Host Name/Address and Port for BMP Server

host: string: Name of the BMP server(accepts IPv4/IPv6 Address format too)
port: string: Port Number of listening BMP server

Example

{
  "host": "string",
  "port": "string"
}